Skip to main content
POST
Send an event

Authorizations

Authorization
string
header
required

Your API key (fk_live_…) from Settings → Developers.

Body

application/json
event
string
required
Maximum string length: 120
Example:

"Transfer failed"

userId
string

Your own user ID. Saved even before they ever chat, and creates the contact if needed.

Example:

"user_42"

phone
string

For someone already chatting on WhatsApp. 7 to 15 digits with the country code.

Example:

"+2348012345678"

properties
object

Up to 20. amount and reference get their own rows on the card.

Example:
level
enum<string>

"problem" puts the event at the top of the agent's panel in red. Leave it out and words like failed, declined or rejected in the name make it a problem.

Available options:
problem,
info
occurredAt
string<date-time>

Defaults to now. Can't be in the future.

Example:

"2026-10-15T09:30:00Z"

Response

Saved.

id
string
Example:

"3f6c1b2e-8a4d-4c1e-9b7a-2d5e6f708192"

event
string
Example:

"Transfer failed"

level
enum<string>
Available options:
problem,
info
occurredAt
string<date-time>
Example:

"2026-10-15T09:30:00Z"

postedToConversations
integer

How many active chats received a card.

Example:

1