Test a Webhook Subscription

Request

Sends a test event matching one of the subscribed event types to the subscription URL and returns the HTTP response status. When the subscription has more than one event type, eventType must be provided.

Security

api_key

Path

idstringrequired

Unique identifier of the webhook to test

x-managed-company-idstring

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

Bodyapplication/json

eventTypestring

Event type to test. Required when the webhook subscription has more than one configured event type.

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

Example:"job.status.changed"

curl -i -X POST \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/webhooks/{id}/test' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string' \
  -d '{
    "eventType": "job.status.changed"
  }'

Responses

Webhook test response with HTTP status code

Bodyapplication/json

statusCodenumberrequired

HTTP status code received from the webhook endpoint

Example:200

successbooleanrequired

Whether the webhook delivery was successful

Example:true

Response

{
  "statusCode": 200,
  "success": true
}