Send fire request

Send a message to Functions event handlers.

Path Parameters
pub_key string — REQUIRED

You app’s publish key from Admin Portal.

Example: pub-c-50264475-1902-558x-b37b-56d7fb64bf45
sub_key string — REQUIRED

Your app's subscribe key from Admin Portal.

Example: sub-c-50264475-1902-558x-d213-7p19052012n2
channel string — REQUIRED

The channel name to perform the operation on.

Example: myChannel
callback string — REQUIRED

The JSONP callback name to wrap the function in. Use 0 for no callback.

Example (myCallback): myCallback
Example (zero): 0
Query Parameters
store integer

This parameter overrides the default account configuration on message saving. 1 to Save, 0 not to save. Fire should have the value 0 for this query parameter as the message is not stored in Message Persistence.

auth string

String which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled.

Example: myAuthKey
meta string

JSON with additional information. Contains additional information about the message, which can be used for stream filtering. Value must be a JSON stringified and URI encoded string.

Example (meta sample): %7B%22cool%22%3A%22meta%22%7D
uuid string

A UTF-8 encoded string of up to 64 characters used to identify the client.

Example: myUniqueUserId
norep boolean — REQUIRED

No replication across POPs. This value should be true for Fire as a message sent using Fire is not replicated.

Example: true
signature string

Signature used to verify that the request was signed with the secret key associated with the subscribe key.

If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature.

timestamp integer

Unix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.

Required if the signature parameter is supplied.

Responses
200

OK

400

Bad Request

Schema — OPTIONAL
undefined[]
403

Forbidden

Schema — OPTIONAL
undefined[]
413

Message payload is too large (>=32K)

Schema — OPTIONAL
undefined[]
429

Request rate limit exceeded

Schema — OPTIONAL
status integer — OPTIONAL
error boolean — OPTIONAL
message string — OPTIONAL