Skip to main content
POST
queue.message.publish

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-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
url
string
required

Your public HTTPS delivery URL, without credentials or private hosts.

body
string
required

Message body, at most 1 MiB in UTF-8 bytes.

headers
object

At most 20 delivery headers: content-type, authorization, accept, x-request-id, x-correlation-id, x-event-type, x-signature or x-trace-id.

retries
integer
default:3

Delivery retries, 0 to 5; costs are billed by your connected account.

Required range: 0 <= x <= 5
delaySeconds
integer

Delay before delivery, in seconds.

Required range: 0 <= x <= 2592000
deduplicationId
string

Optional deduplication id; the request idempotency key takes precedence.

Minimum string length: 1

Response

The result

accepted
boolean
required

The delivery service accepted the message.

ref
string

Reference to what this call created. Pass it as ref to queue.message.cancel.