Webhooks

Overview

Stackla Webhooks enable callbacks to be made to your HTTP(S) endpoints when specific events have been triggered (often referred to as notifications).

For each of the Webhook types you can enter the URL of your endpoints, and Stackla will make HTTP POST requests with the relevant data to the endpoints when the events occur. The URLs entered can be different, or the same URL can be configured for all of them and the payload of the POST can be used to determine the Webhook.

To start receiving notifications, simply enter the relevant URLs in the Stackla API > Webhooks area of your Stack’s Admin Portal. To stop receiving notifications, simply remove the URL from the Webhook’s field.

Webhook notifications are generally in near-realtime, however during times of very high load, there may be a delay of several seconds before the notification arrives.

Security Restrictions

Webhooks may originate from a variety of servers and IP addresses, by default. If you require to whitelist IP address ranges in order to receive webhooks, please contact our support team or your Customer Success Manager to organise a custom solution.

Stackla Webhooks also support appending a ‘Secret Key’ to the Notification if required.

Notification Data

Notifications will arrive as HTTP POST requests, with Content-Type set to “application/json”. This may mean a slightly different strategy for grabbing POST data for languages such as PHP, which will not be able to read directly from $_POST.

Webhook Types

Stackla supports the following types of Webhooks:

TILE_CLAIM

A callback will be made via HTTP POST when an individual Tile has been claimed.

Data
Field Description
_id Stackla ID of the Tile
sta_feed_id External ID provided by the Stackla Feed or API posted Tile
guid Alias of sta_feed_id
network Name of network user belongs to (e.g. “twitter”, “instagram”, etc.)
network_id ID of original content on the network
network_user_id ID of user on the network
network_user_name Display name of user on the network
network_user Handle of user on the network
action “TILE_CLAIM”
votes Number of votes currently on the Tile
claimed_data.claimed_at Timestamp of the claim action
claimed_data.claimed_by Claiming method: “hashtag” (by response) | “invite” (by registration)
claimed_data.message If claim is actioned by response, this will be the response message
claimed_data.custom_data.[key] Value of the custom field key

Back to top

TILE_STATUS_UPDATE

A callback will be made via HTTP POST when an individual Tile’s status has been updated.

Data
Field Description
_id Stackla ID of the Tile
sta_feed_id External ID provided by the Stackla Feed or API posted Tile
guid Alias of sta_feed_id
network Name of network the post/tile originated on (e.g. “twitter”, “instagram”, etc.)
network_id ID of post on the network
action “TILE_STATUS_UPDATE”
status The new status of the tile: “published” | “disabled” | “queued”
old_status The previous status of the tile: “published” | “disabled” | “queued”
terms An array of the Term IDs that the tile is associated with
tags An array of the Tag IDs that have been assigned for the Tile
updated_time Timestamp of event generation
custom_fields.[key] Value of the custom field key
Usage Examples

Back to top

TILE_TAGS_UPDATE

A callback will be made via HTTP POST when an individual Tile has had its tags updated.

Data
Field Description
_id Stackla ID of the Tile
sta_feed_id External ID provided by the Stackla Feed or API posted Tile
guid Alias of sta_feed_id
network Name of network the post/tile originated on (e.g. “twitter”, “instagram”, etc.)
network_id ID of post on the network
action “TILE_TAGS_UPDATE”
tags An array of the Tag IDs
old_tags An array of the previous Tag IDs
updated_time Timestamp of event generation

Back to top

TILE_VOTES_UPDATE

A callback will be made via HTTP POST when an individual Tile has been voted on.

Data
Field Description
_id Stackla ID of the Tile
sta_feed_id External ID provided by the Stackla Feed or API posted Tile
guid Alias of sta_feed_id
network Name of network the post/Tile originated on (e.g. “twitter”, “instagram”, etc.)
network_id ID of post on the network
action “TILE_VOTES_UPDATE”
votes Number of current votes for the Tile

Back to top

TILE_INGESTED

A callback will be made via HTTP POST when an individual tile has been ingested.

Data
Field Description
_id Stackla ID of the Tile
sta_feed_id External ID provided by the Stackla Feed or API posted Tile
guid Alias of sta_feed_id
network Name of network the post/Tile originated on (e.g. “twitter”, “instagram”, etc.)
network_id ID of post on the network
action “TILE_INGESTED”
status The new status of the Tile: “published” | “disabled” | “queued”
terms An array of the Term IDs that the tile is associated with
tags An array of the Tag IDs that have been assigned for the Tile
updated_time Timestamp of event generation
sentiment_score Numerical representation of the sentiment polarity
custom_fields.[key] Value of the custom field key

Back to top

TILE_LIKE_DISLIKE

A callback will be made via HTTP POST when an individual tile has been like or dislike.

Data
Field Description
_id Stackla ID of the Tile
sta_feed_id External ID provided by the Stackla Feed or API posted Tile
guid Alias of sta_feed_id
network Name of network the post/Tile originated on (e.g. “twitter”, “instagram”, etc.)
network_id ID of post on the network
action “TILE_LIKE_DISLIKE”
likes Number of current like for the Tile
dislikes Number of current dislike for the Tile
type The action type: “like” | “dislike”
updated_time Timestamp of event generation
Usage Examples

Back to top

USER_UPDATE

A callback will be made via HTTP POST when a new user is successfully registered or an existing user profile is updated.

Data
Field Description
id Stackla ID of the User
name User First Name
surname User Last Name
type The action type: “added” | “updated”
username Username
action “USER_UPDATE”
display_timezone User Timezone
email User Email Address
created Timestamp of event generation

Back to top