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

Create Webhook

POST /tenants/{tenant}/webhooks

Creates a webhook and answers its signing secret, the only time besides a rotation that it is returned. Event types come from the catalogue, or * alone for everything. The practice's first webhook sets it up in the Webhook Service through Account Hub. 400 with field errors (event types, name, an https URL), or when the practice is not linked to Account Hub; 409 while webhooks are not switched on in this environment, or when it already has as many webhooks as it may; 503 when the Webhook Service or Account Hub is unavailable.

Requires: Create on OutboundWebhooks.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

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

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
409 Conflict
503 Service Unavailable