Webhooks

Send a test event

Sends a webhook.test event to verify the endpoint is reachable. Returns the delivery result.

post/v1/webhooks/{id}/ping

Request

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

Path parameters

idstring required

Webhook endpoint ID

Response

idstring uuid required
endpointIdstring uuid required
eventTypestring required

Event type

status'pending' | 'success' | 'failed' required
responseStatusinteger

HTTP status code received

responseBodyobject

First 500 chars of response body

attemptsinteger required

Delivery attempt count

lastAttemptAtstring date-time required

Last attempt timestamp

createdAtstring date-time required

Example response

{
  "eventType": "document.completed"
}

Changes

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