API Reference
Status PageRoadmapTestimoniesShare feedback

Update a Webhook subscription

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

Updates a given Webhook subscription. Any parameters not provided are left unchanged.

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

Webhook Id

Body Params
uri
length ≤ 1024

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

string | null

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

boolean
subscribed_events

Select all the events to subscribe to.

string | null

Autogenerated 32 bytes key

scopes

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

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

Choose whether the webhook is enabled or not.

Responses

Updated 1 day 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 1 day ago