Retrieve a project-defined event

GET

project_defined_events

{id}

curl --request GET \
  --url https://api.pocketflows.com/project_defined_events/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "id": "<string>",
  "event": "<string>",
  "display_text": "<string>"
}

Authorization

string

header

required

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

string

required

The ID of the ProjectDefinedEvent object

200 - application/json

The ProjectDefinedEvent object

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"

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>"
}