Live webinar What's new in Sodium: Information Requests, plus Q&A. Thu 19 Nov, 12 noon Information Requests + Q&A, Thu 19 Nov Reserve your place

OutboundWebhookDeliveryDto

One event's delivery to one of the practice's webhooks.

Properties

Name Type Description
idstring

The delivery's id.

The delivery's id.

webhookIdstring

The webhook it goes to.

The webhook it goes to.

eventIdstring

The event's id: the webhook-id header, the same on every attempt, for the receiver to skip repeats.

The event's id: the webhook-id header, the same on every attempt, for the receiver to skip repeats.

eventTypestring

The event type.

The event type.

isTestboolean

Whether it is a test event sent from the test route.

Whether it is a test event sent from the test route.

statusenum

Pending Retrying Succeeded Failed Cancelled

Pending Retrying Succeeded Failed Cancelled

attemptCountinteger

Attempts made so far.

Attempts made so far.

nextAttemptDatestring

When the next attempt is due; null once it is finished.

When the next attempt is due; null once it is finished.

lastStatusCodeinteger

The HTTP status of the last attempt, when the receiver answered.

The HTTP status of the last attempt, when the receiver answered.

createdDatestring

When it was created.

When it was created.

completedDatestring

When it succeeded, failed for good or was cancelled.

When it succeeded, failed for good or was cancelled.

JSON Example

{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhookId": "00000000-0000-0000-0000-000000000000",
  "eventId": "00000000-0000-0000-0000-000000000000",
  "eventType": "string",
  "isTest": false
}

Used By Operations

Contained in Schemas