Skip to main content
POST
/
businesses
/
{id}
/
track
Track an event occuring within a business
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/track \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "<string>",
  "data": {}
}
'
{}
Use this endpoint to send events to Pocketflows and trigger the start of any active triggers. Events must be sent with data which must contain a key "customer" with a customer ID.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Body

application/json
​
event
string
required

The name of the event

​
data
object

The data associated with the event

Response

200 - application/json

HTTP status acknowledging the event was properly received

The response is of type object.