Skip to main content
GET
/
trigger_templates
/
{id}
Retrieve a trigger template
curl --request GET \
  --url https://api.pocketflows.com/trigger_templates/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trigger": {
    "id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "name": "<string>",
    "project_defined_event": "<string>",
    "internal_event_definition": {
      "type": "customer_created",
      "segment": "<string>"
    },
    "steps": [
      {
        "type": "email",
        "email_template_id": "<string>",
        "custom_step_id": "<string>"
      }
    ],
    "status": "draft",
    "filter": "<string>",
    "email_address": "<string>",
    "phone_number": "<string>",
    "attributed_revenue": 123,
    "metadata": {},
    "statistics": {
      "emails": {
        "sent": 123,
        "delivered": 123,
        "opened": 123,
        "soft_bounced": 123,
        "hard_bounced": 123,
        "spam_reported": 123,
        "clicked": 123
      },
      "custom_steps": [
        {
          "custom_step": "<string>",
          "sent": 123
        }
      ],
      "executions": {
        "total": 123,
        "pending": 123,
        "started": 123,
        "finished": 123,
        "errored": 123
      },
      "sms": {
        "sms_sent_count": 123,
        "sms_sent_segments_count": 123,
        "mms_sent_count": 123,
        "mms_sent_segments_count": 123
      },
      "total_customers_enrolled": 123,
      "total_customers_started": 123,
      "total_customers_finished": 123
    },
    "trigger": "<string>"
  },
  "enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.pocketflows.com/llms.txt

Use this file to discover all available pages before exploring further.

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 trigger template

Response

200 - application/json

The retrieved TriggerTemplate

id
string
required

The ID of the trigger template

title
string
required

The title of the trigger template

description
string
required

The description of the trigger template

trigger
The Trigger object · object
required

The trigger that will get created when the trigger template is used as a base

enabled
boolean
required

Whether the trigger template is enabled