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

OutboundWebhookCreatedDto

A new webhook with its signing secret: the only time, besides a rotation, the secret is returned.

Properties

Name Type Description
idstring

The webhook's id.

The webhook's id.

namestring

What the practice calls it.

What the practice calls it.

urlstring

Where events are posted.

Where events are posted.

eventTypesarray of string

The event types it wants, or * alone for everything.

The event types it wants, or * alone for everything.

payloadModeenum

Full Thin

Full Thin

isEnabledboolean

Whether events are sent to it.

Whether events are sent to it.

disabledReasonenum

Manual Failing Gone

Manual Failing Gone

disabledDatestring

When it was switched off; null while enabled.

When it was switched off; null while enabled.

healthOutboundWebhookHealthDto
currentSecretCreatedDatestring

When the current signing secret was issued.

When the current signing secret was issued.

previousSecretExpiresDatestring

When the secret before it stops being valid; null outside a rotation's overlap.

When the secret before it stops being valid; null outside a rotation's overlap.

createdDatestring

When it was created.

When it was created.

updatedDatestring

When it was last changed.

When it was last changed.

secretstring

The signing secret (whsec_…). Show it once; it cannot be read again.

The signing secret (whsec_…). Show it once; it cannot be read again.

JSON Example

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "url": "string",
  "eventTypes": [
    "string"
  ],
  "payloadMode": "Full"
}

Used By Operations