Skip to main content
WEBHOOK

Event Types

  • CUSTOMER.CREATED - A new customer has been created
  • CUSTOMER.UPDATED - Customer information has been updated
  • CUSTOMER.DELETED - A customer has been deleted

Sample Payloads

Customer Created

Customer Updated

Customer Deleted

Delete events carry the same full customer object as create and update events. Afriex reads the record before removing it and sends it in full, so CUSTOMER.DELETED gives you the customer’s last known state. There is no slimmed-down delete payload and no deletedAt field.

Body

application/json
id
string<uuid>
required

Unique ID of this event. Every delivery attempt of the same event carries the same id, so use it to ignore a delivery you have already processed.

Example:

"8f14e45f-ceea-4e7a-9f1d-6b1c2a3d4e5f"

event
enum<string>
required

Identifies which customer event occurred

Available options:
CUSTOMER.CREATED,
CUSTOMER.UPDATED,
CUSTOMER.DELETED
Example:

"CUSTOMER.UPDATED"

createdAt
string<date-time>
required

When Afriex created the event. Retries keep this value, and the signature covers it, so you can reject a delivery that is older than you expect.

Example:

"2026-04-24T09:13:33.883Z"

data
object
required

The customer data relevant to this event

Response

Acknowledge receipt. Return any 2xx status code quickly. Response body is ignored.