Skip to main content
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": "read",
        "clientKey": "YOUR_CLIENT_KEY",
        "webhooks": [
            {
                "webhookKey": "WEBHOOK_KEY"
            }
        ]
    }
}'
{
    "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"
}

Documentation Index

Fetch the complete documentation index at: https://about.sendforsign.com/llms.txt

Use this file to discover all available pages before exploring further.

Body parameters

data
object
required

Response

webhooks
string
Array of webhooks.
code
string
The code of the answer.
message
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": "read",
        "clientKey": "YOUR_CLIENT_KEY",
        "webhooks": [
            {
                "webhookKey": "WEBHOOK_KEY"
            }
        ]
    }
}'
{
    "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"
}