webhooks

Queue a signed ping

post/v1/webhooks/{endpoint_id}/test

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Path parameters

endpoint_idstring required

Response

The queued ping delivery.

idstring required

The delivery: one event to one endpoint

endpoint_idstring required

The endpoint

event_idstring required

The event, the webhook-id header

topicstring required

quiz.started | quiz.finished | quiz.abandoned | identity.captured | quiz.published | experiment.started | experiment.ended | profile.created | profile.updated | export.completed | webhook.endpoint.disabled | ping

status'pending' | 'retrying' | 'delivering' | 'delivered' | 'dead' required

pending | retrying | delivering | delivered | dead

attemptsinteger required

How many times it was sent

next_attempt_atstring date-time required

When it is sent next

last_status_codeinteger nullable required

The HTTP status of the last attempt; null when none was received

last_responsestring nullable required

The start of the last response body, at most 1024 bytes

last_errorstring nullable required

Why the last attempt failed without a status, or why the delivery died; null otherwise

created_atstring date-time required

When the event was queued for this endpoint

delivered_atstring date-time nullable required

When it was delivered; null until then

Example response

{
  "id": "whd_7c9e6679742540de944be07fc1f90ae7",
  "endpoint_id": "whe_7c9e6679742540de944be07fc1f90ae7",
  "event_id": "evt_7c9e6679742540de944be07fc1f90ae7",
  "payload": {
    "id": "evt_7c9e6679742540de944be07fc1f90ae7"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.