Skip to main content
POST
Send a test event

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

The workspace the key was issued for, as returned by GET /api/v1/workspaces. Optional: omitting it acts in the key's workspace, and any other id is rejected with 401.

Path Parameters

endpointId
string
required

Body

application/json
event
enum<string>
required

The event to send a sample of. The endpoint must be subscribed to it.

Available options:
PACKAGE_SENT,
PACKAGE_COMPLETED,
PACKAGE_VOIDED,
PACKAGE_EXPIRED,
PACKAGE_DECLINED,
PACKAGE_ON_HOLD,
PACKAGE_RESUMED,
PACKAGE_SCHEDULED,
PACKAGE_DELETED,
SESSION_SENT,
SESSION_OPENED,
SESSION_COMPLETED,
SESSION_DECLINED,
SESSION_REMINDED,
SESSION_CANCELLED
Example:

"PACKAGE_COMPLETED"

Response

Success

data
object
required