Gist
Search…
Webhook
Webhooks are the easiest way to send real-time messages to users.

Setup

Required Headers

Key
Value
Content-Type
application/json
X-Bourbon-Organization-Id
Your Organization Id
X-Gist-Service-Key
Your Service Key
Service keys can be managed from the gist app.

Properties

Property
Description
messageId
The message id
userToken
A token which is generated by your backend
priority
A value between 1-10, Queue order is based on this value. 1 is highest.
expiry
A UTC expiry date time field in ISO format. If not set, message will be set to expire 1 year from queuing.
properties
A dynamic object containing additional information which can be referenced in a message. This field is not required.
properties.gist
An object used by the client libraries to determine how the message should be rendered.

Gist Properties

Property
Description
elementId
When a value is specified the message will be embedded instead of shown as a modal message.
position
Determines how a modal message is displayed. The values are: center, top & bottom. If not specified, the message will default to center position.
routeRuleApple
A regular expression that determine when a message is shown to a user on the Apple platforms. If not specified, the message will appear as soon as the user is in your product.
routeRuleAndroid
A regular expression that determine when a message is shown to a user on the Android platform. If not specified, the message will appear as soon as the user is in your product.
routeRuleWeb
A regular expression that determine when a message is shown to a user on the Web platform. If not specified, the message will appear as soon as the user is in your product.

Queuing One Message

Endpoint
1
https://queue.api.gist.build/api/v1/messages
Copied!
Request Body
1
{
2
"messageId": "welcome",
3
"userToken": "ABC123",
4
"priority": 1,
5
"expiry": "2021-01-31T14:30:00Z",
6
"properties": {
7
"firstName": "Paul",
8
"gist": {
9
"position": "center",
10
"routeRuleWeb": "home\/([^\\s]+)"
11
}
12
}
13
}
Copied!

Queuing Multiple Messages

Endpoint

1
https://queue.api.gist.build/api/v1/messages/bulk
Copied!
Request Body
1
{
2
"messages": [
3
{
4
"messageId": "welcome",
5
"userToken": "ABC123",
6
"priority": 1,
7
"expiry": "2021-01-31T14:30:00Z",
8
"properties": {
9
"firstName": "Paul"
10
"gist": {
11
"position": "center",
12
"routeRuleWeb": "home\/([^\\s]+)"
13
}
14
}
15
},
16
{
17
"messageId": "welcome",
18
"userToken": "XYZ890",
19
"priority": 1,
20
"expiry": "2021-01-31T14:30:00Z",
21
"properties": {
22
"firstName": "John"
23
"gist": {
24
"position": "center",
25
"routeRuleWeb": "home\/([^\\s]+)"
26
}
27
}
28
}
29
]
30
}
Copied!
There's a max limit of 1,000 messages per request.
Last modified 3mo ago