Skip to Content
Webhooks

An event was cancelled

If the event was published, its going and waitlisted guests are emailed.

If the event was published, its going and waitlisted guests are emailed.

Header Parameters

webhook-id*string

The delivery ID, the same as the body's id.

webhook-timestamp*string

Unix time in seconds when this attempt was signed.

webhook-signature*string

v1, followed by the base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{body}, keyed with the endpoint's secret (Standard Webhooks). Verify it with webhooks.verify in @whocoming/sdk.

Request Body

application/json
  1. body

The event.cancelled webhook body.

id*string

Unique per delivery and the same on every retry. Also the webhook-id header. Use it to ignore duplicates.

Match^dlv_[0-9A-Za-z]{6,64}$
created_at*string

ISO 8601 with a UTC offset.

Formatdate-time
mode*string

live or test. Always the mode of the API key that made the request.

Value in"live""test"
type*"event.cancelled"
Value in"event.cancelled"
data*

The event after the change. Sent with every event.* event type. Counts and the page URL are not included; read the event for them.

Response Body

Answer with any 2xx status to acknowledge. Anything else, or no answer, is retried with backoff for 24 hours.

Example Requests
POST/event.cancelled

The event.cancelled webhook body.

Request Body
application/json
{  "id": "string",  "created_at": "2019-08-24T14:15:22Z",  "mode": "live",  "type": "event.cancelled",  "data": {    "id": "string",    "mode": "live",    "series_id": "string",    "slug": "string",    "title": "string",    "description": "string",    "starts_at": "string",    "ends_at": "string",    "timezone": "string",    "location_name": "string",    "location_address": "string",    "online_url": "string",    "capacity": 0,    "max_guests": 0,    "waitlist_enabled": true,    "visibility": "public",    "status": "draft",    "price_note": "string",    "cover_image_url": "string",    "fields": [      {        "key": "string",        "label": "string",        "type": "text",        "required": true      }    ],    "created_at": "string",    "updated_at": "string"  }}
Header Parameters
{  "webhook-id": "string",  "webhook-timestamp": "string",  "webhook-signature": "string"}