Skip to content

Event completed
Alpha
Webhook

Request

Sent when an event has completed.

For single-session events, this is triggered when the session's end time is reached. For multi-session events, this is triggered when the last session's end time is reached.

Headers
webhook-idstringrequired

Unique identifier for this webhook message. This ID is the same when a webhook is retried due to a previous failure. Use this for deduplication.

webhook-timestampstringrequired

Timestamp of when the webhook was sent, in seconds since epoch. Compare against your system time to prevent replay attacks.

webhook-signaturestringrequired

Base64-encoded HMAC-SHA256 signature for verifying the webhook authenticity. The signature is computed over: {webhook-id}.{webhook-timestamp}.{body}.

Bodyapplication/jsonrequired

Information about the completed event.

idstringrequired

Unique identifier for the event.

typestringrequired

The event type.

Value:"v1.event.completed"
timestampstring, (date-time)required

Timestamp of when the event occurred.

payloadobject(EventCompletedEventV1)required

The event-specific payload data.

POST
v1.event.completed
Payload
{
  "id": "string",
  "type": "v1.event.completed",
  "timestamp": "2019-08-24T14:15:22Z",
  "payload": {
    "event_id": "string",
    "host_id": "string"
  }
}

Responses

OK