Skip to main content

Notify Webhook

The Notify Webhook endpoint sends a one-off event delivery to every URL configured on your signature webhook. It calls the exact same backend logic as Test Webhook: both accept the same body and return the same response shape. This endpoint exists for API surface symmetry with the "notify" naming some integrations expect; new integrations should call Test Webhook instead.

When to use it​

Use this endpoint (or Test Webhook) to confirm your receiving endpoint handles a TurboSign event correctly, without waiting for a real document to reach that state.

Example request​

curl -X POST "https://api.turbodocx.com/api/webhooks/signature/notify" \
  -H "Authorization: Bearer $TURBODOCX_API_KEY" \
  -H "x-rapiddocx-org-id: $TURBODOCX_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "eventType": "signature.document.completed",
    "payload": {"documentId": "doc_abc123", "status": "completed"}
  }'

Both eventType and payload are optional; omit them to send a default sample payload for a default event type.

Example response​

{
  "data": {
    "deliveries": [
      {
        "id": "d3a1c2b4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "eventType": "signature.document.completed",
        "url": "https://example.com/webhooks/turbodocx",
        "httpStatus": 200,
        "attemptCount": 1,
        "maxAttempts": 3,
        "isDelivered": true,
        "status": "delivered"
      }
    ],
    "summary": { "total": 1, "successful": 1, "failed": 0, "errors": [] }
  },
  "message": "Manual notification sent successfully to all URLs"
}

Common errors​

StatusWhenResponse body
401Missing or invalid API key/token, or the organization cannot be resolvedEmpty (status only)
403The key's role is not administratorEmpty (status only)
404No webhook with that name exists in your organization{ "error": "Webhook not found" }
400The webhook exists but isActive is false{ "error": "Cannot send notification to inactive webhook" }
Last updated on