Disable Webhook Subscription

POST /v2/partner/webhook-subscriptions/{id}/disable

Required scopes

partner:webhooks:write

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID disableWebhookSubscription
Tags Operations

Parameters

Name In Type Description
id * path id

Responses

200
OK
object
FieldTypeDescription
id *idUUID v4.
type *enum (1)
webhook_subscription
team_id *idUUID v4.
namestring
target_url *string (uri)
event_types *items[]
is_active *boolean
is_disabled_for_failures *boolean
consecutive_permanent_failures *integer
last_delivered_atupdated_atRFC 3339 / ISO 8601 timestamp.
inserted_at *updated_atRFC 3339 / ISO 8601 timestamp.
updated_at *updated_atRFC 3339 / ISO 8601 timestamp.

Example request

POST https://api.digitalonboarding.com/v2/partner/webhook-subscriptions/{id}/disable
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }