API Documentation
MCP
Contract
PDF and Word
Placeholder
Template
Webhook
Read webhook
Get information about a specific webhook.
Copy
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "read",
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY"
}
]
}
}'
Copy
{
"webhooks": [
{
"createTime": "2024-04-08T08:58:54.000Z",
"changeTime": "2024-04-08T09:01:12.000Z",
"url": "URL",
"secret": "whsec_123",
"webhookKey": "WEBHOOK_KEY",
"created": true,
"seen": true,
"sent": false,
"approved": false,
"signed": false,
"fullySigned": false
}
],
"code": "201",
"message": "Webhooks read"
}
Body parameters
Action type.
Array of webhooks.
Show child attribute
Show child attribute
Webhook’s key.
Response
Array of webhooks.
Show child attribute
Show child attribute
Create time.
Webhook’s endpoint.
Webhook’s secret.
Webhook’s key.
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
.
The code of the answer.
The message of the answer.
Copy
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "read",
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY"
}
]
}
}'
Copy
{
"webhooks": [
{
"createTime": "2024-04-08T08:58:54.000Z",
"changeTime": "2024-04-08T09:01:12.000Z",
"url": "URL",
"secret": "whsec_123",
"webhookKey": "WEBHOOK_KEY",
"created": true,
"seen": true,
"sent": false,
"approved": false,
"signed": false,
"fullySigned": false
}
],
"code": "201",
"message": "Webhooks read"
}
Copy
curl -X POST 'https://api.sendforsign.com/api/webhook' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "read",
"webhooks": [
{
"webhookKey": "WEBHOOK_KEY"
}
]
}
}'
Copy
{
"webhooks": [
{
"createTime": "2024-04-08T08:58:54.000Z",
"changeTime": "2024-04-08T09:01:12.000Z",
"url": "URL",
"secret": "whsec_123",
"webhookKey": "WEBHOOK_KEY",
"created": true,
"seen": true,
"sent": false,
"approved": false,
"signed": false,
"fullySigned": false
}
],
"code": "201",
"message": "Webhooks read"
}
Assistant
Responses are generated using AI and may contain mistakes.