Skip to main content
POST
/
v1
/
orgs
/
{org_id}
/
triggers
Create Trigger
curl --request POST \
  --url https://api.letpiper.com/v1/orgs/{org_id}/triggers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "trigger_type": "scheduled",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "cron_expression": "<string>",
  "timezone": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "trigger_type": "scheduled",
  "status": "active",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "cron_expression": "<string>",
  "timezone": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "webhook_secret": "<string>",
  "webhook_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
trigger_type
enum<string>
required
Available options:
scheduled,
webhook
​
agent_id
string<uuid> | null
​
message
string | null
​
cron_expression
string | null
​
timezone
string | null

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
trigger_type
enum<string>
required
Available options:
scheduled,
webhook
​
status
enum<string>
required
Available options:
active,
inactive
​
organization_id
string<uuid>
required
​
agent_id
string<uuid> | null
required
​
message
string | null
required
​
cron_expression
string | null
required
​
timezone
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
webhook_secret
string | null
required
​
webhook_url
string | null