Send fire request
Send a message to Functions event handlers and Illuminate.
| Path Parameters |
|---|
pub_key string — REQUIREDYou app’s publish key from Admin Portal. Example:
|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. Example:
|
channel string — REQUIREDThe channel ID to perform the operation on. Example:
|
callback string — REQUIREDThe JSONP callback name to wrap the function in. Use Example (myCallback):
Example (zero):
|
| Query Parameters |
|---|
store integerThis parameter overrides the default account configuration on message saving. |
auth stringString which is either the auth key (Access Manager legacy) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Example:
|
meta stringJSON 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):
|
uuid stringA UTF-8 encoded string of up to 92 characters used to identify the client. Example:
|
norep boolean — REQUIREDNo replication across POPs. This value should be Example:
|
signature stringSignature 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 integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP. Required if the |
| Responses | ||||
|---|---|---|---|---|
200OK | ||||
400Bad Request
| ||||
403Forbidden
| ||||
413Message payload is too large (>=32KiB)
| ||||
429Request rate limit exceeded
|