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

Update Webhook

PUT /tenants/{tenant}/webhooks/{webhookId}

Replaces the webhook's name, URL, event types, payload mode and whether it is enabled; its secret is kept. Switching it off cancels its deliveries still waiting; switching it back on, or a new URL, clears its failure history. 400 with field errors. 409 while webhooks are not switched on in this environment.

Requires: Update on OutboundWebhooks.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

webhookId* path string (uuid)
{
  "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
404 Not Found
409 Conflict
503 Service Unavailable