OCoctaneai
webhooks

A test event

Sent to the endpoint you ping; a successful ping activates an unverified endpoint. GET /v1/events does not list it.

postWebhookping

Payload

idstring required

The event id, also sent as the webhook-id header; deduplicate on it

typestring required

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

createdstring date-time required

When the event happened

api_version'v1'

The payload version

Example payload

{
  "id": "evt_7c9e6679742540de944be07fc1f90ae7",
  "data": {
    "object": {
      "endpoint_id": "whe_7c9e6679742540de944be07fc1f90ae7"
    }
  }
}

Response

Any 2xx within 10 seconds acknowledges the event

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.