Skip to main content
POST
/
webhooks
/
{id}
/
test
Test a webhook
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/webhooks/{id}/test \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "status_code": 200,
  "webhook_event_id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Test webhook delivered successfully",
  "headers_sent": {
    "X-Firma-Event": "webhook.test",
    "X-Firma-Signature": "Generated HMAC-SHA256 signature",
    "X-Firma-Delivery": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Webhook ID

Response

Test webhook sent successfully

​
success
boolean

Whether the test webhook was delivered successfully

​
status_code
integer

HTTP status code returned by the webhook endpoint

​
webhook_event_id
string<uuid>

ID of the webhook event record

​
message
string
​
headers_sent
object

Headers sent with the test webhook request