Create a webhook

POST {{APIv1 URL}}/webhooks

Body Arguments

ArgumentRequired?Description
webhook_typeRequiredThe type of trigger for the webhook to be created. Any of the following: send-envelope,
signed-envelope,
cancelled-envelope,
rejected-envelope,
bounced-envelope,
add-user,
add-contact,
opened-envelope ,
add-template,
all,
signed-envelope-complete,
verify-envelope-widget,
signed-envelope-widget,
send-envelope-failed
webhook_urlRequiredA string of the URL for the webhook to be created.

Request Body

{"webhook_type"=>"all", "webhook_url"=>"https://example.com"}

RESPONSES

status: OK

{"http":200,"message":"The webhook (https://example.com) has been created","href":"https://api.signable.co.uk/v1/webhooks/142669","webhook_id":"142669","webhook_url":"https://example.com","webhook_type":"all","webhook_created":"2021-12-13T15:18:06+0000"}