Registriert einen neuen Webhook

POST/webhooks/

API version

v1

Request method

POST

Operation ID

createWebhook

---

Registriert einen neuen Webhook für einen bestimmten Login

Request

Responses

Format

application/json

Description

Der erstellte Webhook

Schema documentation

• uidstring
• urlstring (uri)

  required
• methodstring (one of: GET, POST, PUT, DELETE, PATCH)

  required
• eventType"DOMAIN_REGISTRATION_STATUS"

  required
• headersobject
• parametersobject
  • keystring
  • valuestring

Example

{
  "uid": "string",
  "url": "string",
  "method": "GET",
  "eventType": "DOMAIN_REGISTRATION_STATUS",
  "headers": {},
  "parameters": {
    "key": "string",
    "value": "string"
  }
}

JSON Schema

{
  "title": "Webhook",
  "required": [
    "eventType",
    "method",
    "url"
  ],
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "DELETE",
        "PATCH"
      ]
    },
    "eventType": {
      "type": "string",
      "enum": [
        "DOMAIN_REGISTRATION_STATUS"
      ]
    },
    "headers": {
      "type": "object",
      "properties": {}
    },
    "parameters": {
      "title": "WebhookParameter",
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"uid":"string","url":"string","method":"GET","eventType":"DOMAIN_REGISTRATION_STATUS","headers":{},"parameters":{"key":"string","value":"string"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/webhooks