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>'
{
  "message": "Test webhook sent successfully",
  "webhook_id": "123e4567-e89b-12d3-a456-426614174000",
  "test_payload": {
    "event": "webhook.test",
    "webhook_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2024-03-20T15:30:00Z"
  },
  "response_status": 200,
  "response_time_ms": 245
}

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

​
message
string
​
webhook_id
string<uuid>
​
test_payload
object
​
response_status
integer
​
response_time_ms
integer
⌘I