Skip to main content
POST
Push a custom event onto a customer

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

customerId
string
required

the customer id

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

branchId
string

Optional: the branch id

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Body

application/json
eventType
string
required

The event type. Must be one of the custom customer events declared for the product; read them from GET /config/{productId}.

metadata
object[]

metadata assigned to the object

Response

The response is of type object.