Skip to main content
POST
apps.trigger-deployment.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
string
required

The app id, lowercase, like "gmail" or "googlecalendar".

Pattern: ^[a-z0-9_-]{1,64}$
triggerId
string
required

Reviewed trigger: gmail.new-message or googlecalendar.event-change. Other triggers are refused.

Pattern: ^[a-z][a-z0-9.-]{1,127}$
config
object

Reviewed settings only. Mail: interval (minutes, at least 15), labelIds (one label), query (search). Calendar: interval, calendarId, showDeleted. Defaults: 15, INBOX, empty query; primary, true. No credentials or delivery addresses.

Response

The result

triggerId
string
required

The reviewed trigger requested.

ref
string

Reference to what this call created. Pass it as ref to apps.trigger-deployment.get, apps.trigger-deployment.delete, apps.trigger-deployment-events.list.