GraphQL Documentation

One event on its way to one webhook endpoint.

Every event you are subscribed to becomes a delivery job: when something happens in Carerix that matches a webhook's subscribed events, a delivery job is created recording exactly what will be sent to that webhook's endpoint. If several webhooks are subscribed to the same event, each one gets its own independent delivery job, and each succeeds or fails on its own.

A delivery job is not a single HTTP request. It is the intent to deliver, and every request made to fulfil it - the first one and any retries - is recorded as a WebhookDeliveryJobAttempt under attempts . A job that was delivered on the third try has three attempts, two failed and one successful.

#

_createdDateTime

Instant

When the event was queued for delivery. This is when the job was created, not when it was delivered - see the attempts for that.

_id

ID !

Non-null

Webhook Delivery Job id

_kind

ID !

Non-null

Kind of API resource, always is 'WebhookDeliveryJob'

attempts

WebhookDeliveryJobAttemptPage

Every HTTP request made to deliver this job, oldest first - the initial attempt followed by any retries. An empty page means delivery has not been attempted yet.

headers

[ WebhookHeader ]

The custom headers configured on the webhook, captured as they were when this job was created.

payload

String

The event body delivered to the integration's endpoint, as a JSON string

url

String

Endpoint the event was sent to.

webhook

Webhook

The webhook this delivery job belongs to. Null when the webhook has since been deleted, or when the caller lacks the webhook read scope.