curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY",
"url": "URL",
"created": true,
"seen": true
}
]
}
}'
{
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY",
"changeTime": "2024-04-08T09:01:12.000Z"
}
],
"code": "201",
"message": "Webhooks updated"
}
Webhook
Update webhook
Update an existing webhook.
POST
/
api
/
webhook
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY",
"url": "URL",
"created": true,
"seen": true
}
]
}
}'
{
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY",
"changeTime": "2024-04-08T09:01:12.000Z"
}
],
"code": "201",
"message": "Webhooks updated"
}
Body parameters
object
required
Show child attribute
Show child attribute
string
required
Action type.
string
required
Key of the client.
array
required
Array of webhooks. Add the fields that need to be updated and ignore the rest.
Show child attribute
Show child attribute
string
required
Webhook’s key.
string
Webhook’s endpoint.
boolean
Event to listen:
contract.created.boolean
Event to listen:
contract.seen.boolean
Event to listen:
contract.sent.boolean
Event to listen:
contract.approved.boolean
Event to listen:
contract.signed.boolean
Event to listen:
contract.fully_signed.Response
string
The code of the answer.
string
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY",
"url": "URL",
"created": true,
"seen": true
}
]
}
}'
{
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY",
"changeTime": "2024-04-08T09:01:12.000Z"
}
],
"code": "201",
"message": "Webhooks updated"
}
⌘I