cURL

curl --request PUT \
  --url http://localhost/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ]
}
'

{
  "id": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Webhooks

Put v1webhooks

Create or update a webhook subscription for receiving event notifications.

Authentication: Requires Partner API Key (eve_pk_...). Company keys are not accepted.

Create: If no webhook exists, creates a new subscription and returns the signing secret. Store the secret securely — it cannot be retrieved again.

Update: If a webhook already exists, updates the URL and/or event types. The existing signing secret is preserved (not returned on update). Updating also re-activates a webhook that was automatically deactivated.

Event Types:

document.processing.completed — Document processing finished successfully
document.processing.failed — Document processing encountered an error

Webhook URL Requirements:

Must be a valid HTTPS URL
Must be publicly accessible
Should respond with 2xx status within 10 seconds

Webhook Signing: All webhook deliveries include an X-EVE-Signature header containing an HMAC-SHA256 signature of the payload using your webhook secret.

PUT

webhooks

cURL

curl --request PUT \
  --url http://localhost/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ]
}
'

{
  "id": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key

string

header

required

API Key provided by Eve Admin Portal. Include this header in all authenticated requests.

Body

application/json

url

string

eventTypes

string[]

Response

string

url

string

secret

string | null

eventTypes

string[]

isActive

boolean

createdAt

string<date-time>

updatedAt

string<date-time> | null

Get v1webhooks Delete v1webhooks