OCoctaneai
webhooks

A shopper left an email or phone

The moment a session writes an email or phone it had not written before; only to endpoints with include_pii. The session as of the capture, plus the identity.

postWebhookidentity.captured

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": {
      "id": "sess_7c9e6679742540de944be07fc1f90ae7",
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
      "version_id": "ver_7c9e6679742540de944be07fc1f90ae7",
      "experiment_id": "expt_7c9e6679742540de944be07fc1f90ae7",
      "arm_id": "arm_7c9e6679742540de944be07fc1f90ae7",
      "visitor_id": "vis_7c9e6679742540de944be07fc1f90ae7",
      "source_session_id": "sess_7c9e6679742540de944be07fc1f90ae7",
      "source_kind": "share",
      "terminal_page": {
        "shown_products": [
          {
            "product_id": "gid://shopify/Product/8692896989320",
            "variant_id": "gid://shopify/ProductVariant/40926435967056"
          }
        ]
      },
      "products_shown": [
        {
          "product_id": "gid://shopify/Product/8692896989320",
          "variant_id": "gid://shopify/ProductVariant/40926435967056"
        }
      ]
    }
  }
}

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.