Webhooks

Send a test delivery

POST/v1/webhooks/{webhookId}/test

Send a signed test delivery with the event "ping", even if the webhook is inactive. A webhook with a posting spec gets a made-up lead in the buyer's format instead. Check the result in the delivery log.

curl -X POST "$AYEFORM_API/v1/webhooks/$WEBHOOK_ID/test" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

200 Response

{
  "id": "0x4ppa92sn45th2skcfhp95keyz4x3c1",
  "webhookId": "2p9m5rc7a02159pqzeezm5z155bcd5d9",
  "submissionId": "tyq2cjsz9j5bxge22ky5pppfsggct0xe",
  "event": "…",
  "status": "pending",
  "attempts": 1,
  "lastStatus": 1,
  "lastError": null,
  "nextAttemptAt": null,
  "createdAt": 1790879400000,
  "payload": "…",
  "posted": {
    "contentType": "image/jpeg",
    "body": "…"
  }
}

Path parameters

webhookIdstringrequired
The webhook's id.

Response

idstringrequired
The delivery's id.
webhookIdstringrequired
The webhook it was sent to.
submissionIdstring or nullrequired
The response it carries. Null for a test delivery.
eventstringrequired
The event. It is "submission.completed" or "submission.abandoned", or "ping" for a test.
statusenumrequired
pending while it is being sent or retried, succeeded once the endpoint accepted it, and failed after the last attempt failed.
One of "pending", "succeeded", "failed"
attemptsnumberrequired
Attempts made so far.
lastStatusnumber or nullrequired
The HTTP status of the last attempt. Null before the first attempt, or when the endpoint didn't answer.
lastErrorstring or nullrequired
What went wrong on the last attempt. Null when nothing did.
nextAttemptAtnumber or nullrequired
When the next retry is due, in milliseconds since the epoch. Null when none is due.
createdAtnumberrequired
When the delivery was made, in milliseconds since the epoch.
payloadanyrequired
The data field of the request body.
postedone of 2required
The body the test posted, a sample lead in the buyer's format. Null when the webhook has no posting spec.
Show 2 optionsHide 2 options
- Option 1
  - contentTypestringrequired
  - bodystringrequired
- null

Errors answer with a status and the error shape.