Send a test event

Sends one signed webhook.test event to the address now and answers with what the address replied.

POST/api/v1/webhooks/{webhook_id}/test

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the webhooks:manage scope — add, change and delete webhooks.

webhooks:manageChanges the draft or a recordIdempotency-Key requiredMCP tool: send_test_webhook

Parameters

Named placeholders go in the path; the rest in a JSON body.

webhook_idstringPath · required: The webhook's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl

curl -X POST 'https://websites.workflowcorp.com/api/v1/webhooks/WEBHOOK_ID/test' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Example arguments

{
  "webhook_id": "WEBHOOK_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "delivered": {
      "type": "boolean"
    },
    "response_status": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "delivered",
    "response_status",
    "error"
  ],
  "additionalProperties": false
}