Skip to main content
POST
OAuth2 scopes required: write:event-subscription. See Scopes for OAuth apps.
Send a test event to the connection endpoint configured for this subscription. This is useful for verifying that your webhook URL or Klaviyo integration is set up correctly. The test event will contain a sample payload matching the subscription’s event type. Use the optional request body to override parts of it. Each field you omit gets a random value. Do not combine event_type calculated with a support investigation phase or sub_status. The test event can’t be built, so nothing is sent and the response has data.success false.
The test broadcast will use the same authentication and headers configured on the connection.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
subscription_id
integer
required

The id of the subscription to send a test event to.

Body

application/json

Optional overrides for the test event. An omitted field gets a random value. The combination of values is not checked.

​
event_type
enum<string>
default:carrier

The kind of tracking event to send. Only applies to parcels.event.created subscriptions.

Available options:
carrier,
calculated
Example:

"calculated"

​
phase

Overrides the event phase. A support investigation phase sends a claim event. Only applies to parcels.event.created subscriptions.

Available options:
accepted,
announced,
announcing,
attempted,
cancelled,
customs,
delivered,
delivery_forced,
dropped,
in_delivery,
in_transit,
labelled,
no_label,
none,
pup,
ready_to_send,
sorted,
unknown
Example:

"in_transit"

​
exception
enum<string>

Overrides the event exception. With event_type calculated, one of claimable, calculated_delivery_delay, calculated_handover_delay, off_radar or pup_expiration picks the calculated event. Only applies to parcels.event.created subscriptions.

Available options:
address_error,
announcement_failed,
calculated_delivery_delay,
calculated_handover_delay,
cancellation_failed,
cancelled,
cancelled_upstream,
cancelling,
cancelling_upstream,
changed,
claim,
claimable,
customer_rejected,
customer_support,
customs_issue,
damaged,
delay_unknown,
delivery_delay,
dropoff_expiration,
handover_delay,
hold,
missing,
none,
non_conformity,
off_radar,
pup_expiration,
refused,
relabelled,
returned_sender,
sorting_delay,
unknown
Example:

"none"

​
sub_status

Overrides the event sub status. A support investigation sub status sends a claim event. Only applies to parcels.event.created subscriptions.

Available options:
accepted,
additional_information,
carrier,
company_closed,
connection_missed,
content,
cut_off,
damaged,
delay,
delivery_change,
disposed,
documents,
duplicate,
expired,
high_volume,
inaccessible,
incorrect_information,
in_progress,
late,
locker,
mailbox,
max_measure,
max_weight,
mechanical,
misrouted,
missort,
neighbour,
none,
not_home,
not_ordered,
packaging,
parcel_found,
partly,
passed,
payment,
postal_box,
prohibited_item,
pup,
pup_closed,
receiver,
rejected,
requested,
resolved,
safeplace,
sender,
shop,
signature,
traffic,
undeliverable,
unknown,
unknown_receiver,
updated,
weather_conditions,
1,
2,
3
Example:

"none"

​
customer_email
string<email>

Overrides the customer email address.

Example:

"customer@example.com"

Response

OK

Test broadcast result

​
data
Broadcast Result · object

The result of a test event broadcast to a subscription's connection endpoint.