Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Metadata

Attach Metadata to a Signature Request

Add Metadata to a given Signature Request.

post/signature_requests/{signatureRequestId}/metadata

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

Request body

event_idstring uuid required

A unique identifier for this webhook event.

event_namestring required

The name of the webhook event that was triggered.

event_timestring required

The timestamp (Unix epoch format) when the event occurred. It will stay constant even through retries.

subscription_idstring uuid required

The unique identifier of the webhook subscription that received this event.

subscription_descriptionstring required

Description of the webhook subscription.

sandboxboolean required

A boolean indicating whether this event was triggered in a sandbox environment (true) or in production (false).

Example request

{
  "event_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "event_time": "1670855889",
  "subscription_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "subscription_description": "Notifies our system when an even occurs.",
  "sandbox": true
}

Response

Created

event_idstring uuid required

A unique identifier for this webhook event.

event_namestring required

The name of the webhook event that was triggered.

event_timestring required

The timestamp (Unix epoch format) when the event occurred. It will stay constant even through retries.

subscription_idstring uuid required

The unique identifier of the webhook subscription that received this event.

subscription_descriptionstring required

Description of the webhook subscription.

sandboxboolean required

A boolean indicating whether this event was triggered in a sandbox environment (true) or in production (false).

Example response

{
  "event_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "event_time": "1670855889",
  "subscription_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "subscription_description": "Notifies our system when an even occurs.",
  "sandbox": true
}