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

CreateOutboundWebhookRequest

A new webhook as the practice creates it (docs/features/Webhooks/PLAN.md D7).

Properties

Name Type Description
name*string

What the practice calls it. 1 to 100 characters.

What the practice calls it. 1 to 100 characters.

url*string

Where events are posted: an absolute https URL of at most 2048 characters, with no user info.

Where events are posted: an absolute https URL of at most 2048 characters, with no user info.

eventTypes*array of string

The event types it wants, from the catalogue (GET /metadata/outbound-webhook-event-types), or *
alone for every event, including ones added later.

The event types it wants, from the catalogue (GET /metadata/outbound-webhook-event-types), or *
alone for every event, including ones added later.

payloadMode*enum

Full Thin

Full Thin

isEnabled*boolean

Whether events are sent to it. Switching it off cancels deliveries still waiting to be sent.

Whether events are sent to it. Switching it off cancels deliveries still waiting to be sent.

JSON Example

{
  "name": "string",
  "url": "string",
  "eventTypes": [
    "string"
  ],
  "payloadMode": "Full",
  "isEnabled": false
}

Used By Operations