Webhooks

Test a webhook

Send a test payload to the webhook URL to verify it's working correctly

post/webhooks/{id}/test

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/webhooks/:id/test/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Webhook ID

Test webhook sent successfully

successboolean required

Whether the test webhook was delivered successfully

status_codeinteger required

HTTP status code returned by the webhook endpoint

webhook_event_idstring uuid

ID of the webhook event record

messagestring

No recorded changes to this operation across all 13 revisions of this API.