API Reference
Status PageRoadmapTestimoniesShare feedback

Create a Webhook subscription

post
https://api-sandbox.yousign.app/v3/webhooks

Creates a new Webhook subscription in your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Related guide: Webhooks

To create Webhook subscriptions scoped to the Sandbox environment, you can:

  • Do it through the app.
  • Via API: create a webhook subscription in the Production environment with the sandbox parameter set to true.

🔓 Endpoint access

  • Environments: production
  • API key scopes: organization, workspace
  • Plans: plus, pro, scale
  • Add-ons (for production access): none
Body Params
uri
required
length ≤ 1024

HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.

string | null
required

Short description of the webhook.
This property is a Safe String.

boolean
required
subscribed_events
required

Select all the events to subscribe to.

string | null

Autogenerated 32 bytes key

scopes
required

Choose between a wildcard symbol to select all scopes or specify a list of specific scopes.

workspaces

Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs. The association of specific Workspaces with Webhook is temporarily restricted in the sandbox environment, only the value wildcard ("*") for Workspaces is allowed in this context.

boolean
required

If a Webhook request fails for any reason, Yousign will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min

boolean
required

Choose whether the webhook is enabled or not.

Responses

Updated about 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago