Webhooks

Update a webhook endpoint

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/webhooks/{id}
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Webhook endpoint ID

Request body

urlstring

New HTTPS URL for this endpoint

descriptionstring

Human-readable label

enabledEventsstring[]

Events to subscribe to

status'active' | 'disabled'

Enable or disable this endpoint

Example request

{
  "url": "https://example.com/webhooks/signvoy",
  "description": "Production webhook"
}

Response

idstring uuid required
workspaceIdstring uuid required
urlstring uri required

HTTPS URL Signvoy will POST events to

descriptionobject

Human-readable label

enabledEventsstring[] required

Subscribed events. Empty array = all events.

status'enabled' | 'disabled' required
consecutiveFailuresinteger required

Count of consecutive delivery failures

disabledAtstring date-time nullable
successRateinteger nullable

Percentage of successful deliveries (null if no deliveries yet)

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "enabledEvents": [
    "document.completed",
    "document.declined"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.