Webhook Events

The signed events Customer Alliance POSTs to your endpoints.

`review.received` delivered to your endpoint

Your endpoint receives this POST. Respond 2xx to acknowledge; non-2xx (and 3xx) are retried with backoff.

Payload

application/json

Every delivery POSTs this envelope. Verify the X-CA-Signature: sha256=<hex> header — an HMAC-SHA256 of the raw request body keyed by your endpoint's signing secret — before trusting it.

idstring · uuidRequired

Delivery id (also in the X-CA-Delivery-Id header); stable across retries — use it to dedupe.

eventconst: review.receivedRequired

created_atstring · date-timeRequired

Responses

200

Acknowledged.

No content

Payload

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": null,
  "created_at": "2026-08-11T20:22:20.622Z",
  "data": {
    "review_id": "123e4567-e89b-12d3-a456-426614174000",
    "node_id": "123e4567-e89b-12d3-a456-426614174000",
    "platform": "text"
  }
}

`review.replied` delivered to your endpoint

Your endpoint receives this POST. Respond 2xx to acknowledge; non-2xx (and 3xx) are retried with backoff.

Payload

application/json

Every delivery POSTs this envelope. Verify the X-CA-Signature: sha256=<hex> header — an HMAC-SHA256 of the raw request body keyed by your endpoint's signing secret — before trusting it.

idstring · uuidRequired

Delivery id (also in the X-CA-Delivery-Id header); stable across retries — use it to dedupe.

eventconst: review.repliedRequired

created_atstring · date-timeRequired

Responses

200

Acknowledged.

No content

Payload

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": null,
  "created_at": "2026-08-11T20:22:20.622Z",
  "data": {
    "review_id": "123e4567-e89b-12d3-a456-426614174000",
    "node_id": "123e4567-e89b-12d3-a456-426614174000",
    "reply_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

`review.alert_triggered` delivered to your endpoint

Your endpoint receives this POST. Respond 2xx to acknowledge; non-2xx (and 3xx) are retried with backoff.

Payload

application/json

Every delivery POSTs this envelope. Verify the X-CA-Signature: sha256=<hex> header — an HMAC-SHA256 of the raw request body keyed by your endpoint's signing secret — before trusting it.

idstring · uuidRequired

Delivery id (also in the X-CA-Delivery-Id header); stable across retries — use it to dedupe.

eventconst: review.alert_triggeredRequired

created_atstring · date-timeRequired

Responses

200

Acknowledged.

No content

Payload

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": null,
  "created_at": "2026-08-11T20:22:20.622Z",
  "data": {
    "alertId": "123e4567-e89b-12d3-a456-426614174000",
    "ruleId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "message": "text",
    "context": {}
  }
}

`survey.response_completed` delivered to your endpoint

Your endpoint receives this POST. Respond 2xx to acknowledge; non-2xx (and 3xx) are retried with backoff.

Payload

application/json

Every delivery POSTs this envelope. Verify the X-CA-Signature: sha256=<hex> header — an HMAC-SHA256 of the raw request body keyed by your endpoint's signing secret — before trusting it.

idstring · uuidRequired

Delivery id (also in the X-CA-Delivery-Id header); stable across retries — use it to dedupe.

eventconst: survey.response_completedRequired

created_atstring · date-timeRequired

Responses

200

Acknowledged.

No content

Payload

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": null,
  "created_at": "2026-08-11T20:22:20.622Z",
  "data": {
    "survey_id": "123e4567-e89b-12d3-a456-426614174000",
    "response_id": "123e4567-e89b-12d3-a456-426614174000",
    "node_id": "123e4567-e89b-12d3-a456-426614174000",
    "overall_score": null
  }
}

`guest.created` delivered to your endpoint

Your endpoint receives this POST. Respond 2xx to acknowledge; non-2xx (and 3xx) are retried with backoff.

Payload

application/json

Every delivery POSTs this envelope. Verify the X-CA-Signature: sha256=<hex> header — an HMAC-SHA256 of the raw request body keyed by your endpoint's signing secret — before trusting it.

idstring · uuidRequired

Delivery id (also in the X-CA-Delivery-Id header); stable across retries — use it to dedupe.

eventconst: guest.createdRequired

created_atstring · date-timeRequired

Responses

200

Acknowledged.

No content

Payload

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": null,
  "created_at": "2026-08-11T20:22:20.622Z",
  "data": {
    "guest_id": "123e4567-e89b-12d3-a456-426614174000",
    "node_id": "123e4567-e89b-12d3-a456-426614174000",
    "source": "import"
  }
}

`guest.unsubscribed` delivered to your endpoint

Your endpoint receives this POST. Respond 2xx to acknowledge; non-2xx (and 3xx) are retried with backoff.

Payload

application/json

Every delivery POSTs this envelope. Verify the X-CA-Signature: sha256=<hex> header — an HMAC-SHA256 of the raw request body keyed by your endpoint's signing secret — before trusting it.

idstring · uuidRequired

Delivery id (also in the X-CA-Delivery-Id header); stable across retries — use it to dedupe.

eventconst: guest.unsubscribedRequired

created_atstring · date-timeRequired

Responses

200

Acknowledged.

No content

Payload

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": null,
  "created_at": "2026-08-11T20:22:20.622Z",
  "data": {
    "guest_id": null,
    "unsubscribe_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}