Test-fire webhook subscription

This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.

The request queues an event and delivery; success means accepted for asynchronous processing, not that the destination returned a successful response. A paused subscription returns 400. An explicit eventType must be in the catalog and selected by the subscription. When omitted, webhook.test is used. The test delivery targets this subscription directly and bypasses its filters.

Path parameters

subscription_idrequired
string
Subscription ID.

Name	Type	Description
subscription_idrequired	string	Subscription ID.

Body parameters

eventType · optional
string
Optional supported event type, normalized to lowercase. It must be selected by the subscription. Omit to use webhook.test.
data · optional
object
Optional object merged into generated test event data; defaults to {}.

Name	Type	Description
eventType	string	Optional supported event type, normalized to lowercase. It must be selected by the subscription. Omit to use webhook.test.
data	object	Optional object merged into generated test event data; defaults to {}.

Errors

Status	Meaning
400	Invalid payload.
401	Invalid API key or missing auth.
403	Missing webhooks:write scope.
404	Subscription not found.
422	Malformed test body or data field.

Example

bash

curl -X POST "https://app.autotouch.ai/api/webhook-subscriptions/67c88a24b4dd8f2d4999f912/test" \
    -H "Authorization: Bearer stk_your_key_id.your_secret" \
    -H "Content-Type: application/json" \
    -d '{"eventType":"lead.created","data":{"ping":"ok"}}'

Request body

json

{
    "eventType": "lead.created",
    "data": {
      "ping": "ok",
      "origin": "smoke_test"
    }
  }

Response example

json

{
    "success": true,
    "event_id": "evt_7a2d1d95f063e6d97c6f2697",
    "event_type": "lead.created",
    "delivery_count": 1,
    "delivery_id": "dlv_b3a7459b7a09cf5ad255e862"
  }