Skip to main content
POST
/
registerWebhook
Register a webhook
curl --request POST \
  --url https://api.useinkless.com/registerWebhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "eventType": "<string>",
  "secret": "<string>"
}
'
{
  "message": "<string>",
  "webhook": {
    "webhook_id": "<string>",
    "url": "<string>",
    "eventType": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<uri>
required

The URL where webhook notifications will be sent.

​
eventType
string
required

The type of event to subscribe to (e.g., 'document.signed').

​
secret
string | null

Optional secret to sign webhook payloads so recipients can verify authenticity.

Response

Webhook successfully registered.

​
message
string

Success message indicating the webhook was registered.

​
webhook
object