Skip to main content

WebhookMessage

A webhook message sent in response to an activity in EventsAir.

See the webhooks guide for more information, including the webhook event types supported in EventsAir.

type WebhookMessage {
id: String!
payload: JSON
status: WebhookMessageDeliveryStatus!
timestamp: DateTime!
webhookEventTypeName: String!
}

Fields​

WebhookMessage.id ● String! non-null scalar​

Unique identifier of the webhook message.

WebhookMessage.payload ● JSON scalar​

The payload of the webhook message.

Each webhook event type defines its own message payload. The webhook event types page lists examples of payloads for each event type. Optional.

WebhookMessage.status ● WebhookMessageDeliveryStatus! non-null enum​

The delivery status of the webhook message.

WebhookMessage.timestamp ● DateTime! non-null scalar​

The date and time of the webhook message.

WebhookMessage.webhookEventTypeName ● String! non-null scalar​

The webhook event type name associated with this webhook message.

Member Of​

WebhookMessageEdge object