cURL

curl --request GET \
  --url http://localhost/v1/webhooks \
  --header 'X-API-Key: <api-key>'

{
  "id": "<string>",
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "recentDeliveries": {
    "total": 123,
    "delivered": 123,
    "failed": 123,
    "lastDeliveredAt": "2023-11-07T05:31:56Z"
  }
}

Webhooks

Get v1webhooks

Get the current webhook subscription for this partner.

Returns the webhook subscription details including the URL, subscribed event types, active status, and delivery statistics.

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

Response includes:

id - Webhook subscription unique identifier
url - Webhook delivery URL
eventTypes - List of subscribed event types
isActive - Whether the webhook is active
createdAt, updatedAt - Timestamps
recentDeliveries - Delivery statistics (total, delivered, failed, lastDeliveredAt)

Inactive Webhooks: Webhooks are automatically deactivated after 10 consecutive delivery failures. Update the webhook to re-activate it.

Returns 404 if no webhook subscription exists for this partner.

GET

webhooks

cURL

curl --request GET \
  --url http://localhost/v1/webhooks \
  --header 'X-API-Key: <api-key>'

{
  "id": "<string>",
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "recentDeliveries": {
    "total": 123,
    "delivered": 123,
    "failed": 123,
    "lastDeliveredAt": "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.

Response

string

url

string

eventTypes

string[]

isActive

boolean

createdAt

string<date-time>

updatedAt

string<date-time> | null

recentDeliveries

object

Show child attributes

Put v1webhooks