Skip to main content
POST
apps.trigger-deployment-events.list

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
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}$
deploymentId
string

Deployment id from apps.trigger-deployments.list.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
deploymentRef
string

The ref returned by apps.trigger-deployment.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
limit
number

Maximum records to return. Default 10.

Required range: x >= 1
includePayload
boolean
default:false

Return event bodies, which may contain personal data. Default false.

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.