Skip to main content
POST
Send an Event to Addy
Use events to keep customers updated from your own systems: an order shipped, a payment arrived, an appointment moved, a document is ready. Before you start: set your events up in AI Agent → Events. For each event you set:
  • its key (type), such as order_shipped
  • what it means and what Addy should tell the customer
  • the facts it carries, such as order_id and tracking_url
  • a WhatsApp template to use when the 24-hour window has closed
You can also send a type you haven’t set up, as long as you add a description of what happened. What Addy does:
Every event is listed with what happened under AI Agent → Events → Recent events. WhatsApp Pay payments and Cal.com bookings need no event: Addy already knows about them.

Authorizations

x-api-key
string
header
required

Your application's unique ID.

x-api-secret
string
header
required

Your application's secret key.

Body

application/json
phone
string
required

The customer's phone with country code.

Example:

"919876543210"

type
string
required

The event's key, as set up in AdsEra → AI Agent → Events (for example order_shipped, payment_received).

Example:

"order_shipped"

description
string

What happened, in plain words. Needed for events you haven't set up in AdsEra.

Example:

"The order was handed to the courier."

data
object

The facts Addy may tell the customer. Addy only uses what you send here.

Example:
whatsapp
string

Optional: id of the WhatsApp number to send from.

Response

Success

success
boolean
Example:

true

data
object