Webhooks

Create a webhook endpoint

Register a new HTTPS endpoint. The signing secret is returned once in this response and will not be shown again — store it securely.

post/v1/webhooks

Request

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

Request body

urlstring required

HTTPS URL that Signvoy will POST events to

descriptionstring

Human-readable label for this endpoint (shown in the dashboard)

enabledEventsstring[] required

Events to subscribe to. Pass an empty array to subscribe to all events.

Example request

{
  "url": "https://example.com/webhooks/signvoy",
  "description": "Production webhook",
  "enabledEvents": [
    "document.completed",
    "document.declined"
  ]
}

Response

Endpoint created — includes signing secret (shown once)

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
secretstring required

HMAC-SHA256 signing secret. Shown only once — store it securely. Use it to verify the Signvoy-Signature header on inbound events.

Example response

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

Changes

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