Retrieve a Webhook Subscription

Request

Retrieve a webhook subscription by ID.

Security

api_key

Path

idstringrequired

Unique identifier of the webhook to retrieve

Example:01HQXYZ123ABC456DEF789GHI

x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/webhooks/01HQXYZ123ABC456DEF789GHI \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Bodyapplication/json

idstringrequired

Unique identifier of the webhook

Example:"01HQXYZ123ABC456DEF789GHI"

namestringrequired

Name of the webhook. Used for internal identification

Example:"Production Webhook"

urlstringrequired

URL of the webhook endpoint

Example:"https://example.com/webhook"

eventsArray of stringsrequired

Event types that trigger the webhook

Items Enum:"job.status.changed""sending.event.file.ready""sending.event.status.changed""peppol.document.received"

Example:

[
  "job.status.changed",
  "sending.event.status.changed"
]

createdAtstringrequired

Creation timestamp of the webhook

Example:"2026-06-01T10:30:00.000Z"

statusstringrequired

Status of the webhook

Enum:"ACTIVE""DISABLED"

Example:"ACTIVE"

lastModifiedAtstringrequired

Last modification timestamp of the webhook

Example:"2026-06-04T14:20:00.000Z"

Response

{
  "id": "01HQXYZ123ABC456DEF789GHI",
  "name": "Production Webhook",
  "url": "https://example.com/webhook",
  "events": [
    "job.status.changed",
    "sending.event.status.changed"
  ],
  "createdAt": "2026-06-01T10:30:00.000Z",
  "status": "ACTIVE",
  "lastModifiedAt": "2026-06-04T14:20:00.000Z"
}