POpocketflows
Project defined events

Retrieve a project-defined event

get/project_defined_events/{id}

Request

Path parameters

idstring required

The ID of the ProjectDefinedEvent object

Response

The ProjectDefinedEvent object

idstring required

The ID of the project defined event

eventstring required

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

display_textstring required

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

purchase_amount_pathstring nullable required

Path for extracting purchase amount from event data

Changes

No recorded changes to this operation across all 10 revisions of this API.