Skip to main content
POST
apps.trigger.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
key
string
required

Public action or trigger key.

Pattern: ^[a-z0-9][a-z0-9_-]{0,127}$
version
string

Exact definition version; omitted means latest.

Pattern: ^\d+\.\d+\.\d+$

Response

The result

key
string
required

Public action or trigger key.

Pattern: ^[a-z0-9][a-z0-9_-]{0,127}$
name
string
required

Definition name.

Required string length: 1 - 2000
version
string
required

Definition version.

Maximum string length: 64
description
string

What the action or trigger does.

Required string length: 1 - 2000
inputSchema
any

Input fields and required values, with secrets and defaults removed.