Skip to main content
GET
/
project_defined_events
/
{id}
Retrieve a project-defined event
curl --request GET \
  --url https://api.pocketflows.com/project_defined_events/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "event": "<string>",
  "display_text": "<string>",
  "purchase_amount_path": "<string>"
}

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 ProjectDefinedEvent object

Response

200 - application/json

The ProjectDefinedEvent object

​
id
string
required

The ID of the project defined event

​
event
string
required

The event name. Likely takes the form customer.created or similar

​
display_text
string
required

The human-readable text for this event. Should grammatically follow "When..." e.g. "a customer is created"

​
purchase_amount_path
string | null
required

Path for extracting purchase amount from event data