Webhook
Create webhook
API Documentation
Contract
PDF and Word
Placeholder
Template
Webhook
Create webhook
Create a webhook.
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"webhooks": [
{
"url": "URL",
"created": true,
"seen": true,
"sent": false,
"approved": false,
"signed": false,
"fullySigned": true
}
]
}
}'
{
"webhooks": [
{
"createTime": "2024-04-08T08:58:54.000Z",
"url": "testurl1",
"secret": "whsec_123",
"webhookKey": "WEBHOOK_KEY"
}
],
"code": "201",
"message": "Webhooks created"
}
Webhooks are created for the specific client key you use when creating a webhook.
Body parameters
Action type.
Array of webhooks.
Webhook’s endpoint.
Event to listen: contract.created
.
Event to listen: contract.seen
.
Event to listen: contract.sent
.
Event to listen: contract.approved
.
Event to listen: contract.signed
.
Event to listen: contract.fully_signed
.
Response
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"webhooks": [
{
"url": "URL",
"created": true,
"seen": true,
"sent": false,
"approved": false,
"signed": false,
"fullySigned": true
}
]
}
}'
{
"webhooks": [
{
"createTime": "2024-04-08T08:58:54.000Z",
"url": "testurl1",
"secret": "whsec_123",
"webhookKey": "WEBHOOK_KEY"
}
],
"code": "201",
"message": "Webhooks created"
}
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"webhooks": [
{
"url": "URL",
"created": true,
"seen": true,
"sent": false,
"approved": false,
"signed": false,
"fullySigned": true
}
]
}
}'
{
"webhooks": [
{
"createTime": "2024-04-08T08:58:54.000Z",
"url": "testurl1",
"secret": "whsec_123",
"webhookKey": "WEBHOOK_KEY"
}
],
"code": "201",
"message": "Webhooks created"
}