Webhooks

Get Webhook

Retrieve a specific webhook by ID

get/webhooks/{id}

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/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Webhook retrieved successfully

idstring uuid required

Unique identifier for the webhook

urlstring uri required

Webhook URL

descriptionstring nullable

Webhook description

eventsstring[] required

Events that trigger this webhook

enabledboolean required

Whether the webhook is enabled

consecutive_failuresinteger

Number of consecutive delivery failures

auto_disabled_atstring date-time nullable

Timestamp when the webhook was auto-disabled due to failures

created_atstring date-time required

Webhook creation timestamp

updated_atstring date-time

Webhook last update timestamp

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