Webhooks

Patch Webhook Subscription

Patch a Webhook Subscription.

patch/beta/webhooks/{webhookSubscriptionId}

Request

Base URL
https://dev.dixa.io
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/dixa/apis/dixa-api/docs/beta/webhooks/:webhookSubscriptionId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

webhookSubscriptionIdstring uuid required

Request body

namestring

The Webhook Subscription name

eventsstring[]

The set of events this Webhook Subscription subscribes to. Allowed values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]

urlstring

URL of the server that the webhook request should be sent to

customHeadersMapString

enabledboolean

Defines whether this Webhook Subscription is enabled or disabled

filtersMapWebhookEventTypeFilters

Response

The patched Webhook Subscription

Changes

No recorded changes to this operation across all 14 revisions of this API.