If you want to recieve / consume data events from Relayter you can do so using a Webhooks. In this article we will describe how to setup and receive data from Relayter using a Webhook consumer.
Setup a Webhook consumer connection in Relayter
Go to team settings
Click the Connections tab
Click Add Connection
Fill in the name of your Consumer
Select Connection type: Webhook Consumer
Add Webhook event
In the connection detail page you can setup multiple event listeners. Per Relayter event you can fill in the URL Relayter will post the data to. This can be the same URL, or a different URL per event.
In the Connection details page click add Event
Select the Relayter event you want to receive, for instance CAMPAIGN_CREATED
Enter the URL Relayter should post to. N.B. For security reasons we only post data to https urls.
Webhook events
These are the events we currently support. If you would like us to add an event not yet supported, please contact you customer support manager and we will look into adding it in a future release.
CAMPAIGN_CREATED
Fires when a campaign is created in Relayter and includes campaign data (name, tags, etc)PRODUCT_UPDATE
Fires when a product is created in Relayter and includes product data and all asset linked to the product with their files.ASSET_CREATED
Fires when an asset is created in Relayter and includes asset data and image files.ASSET_UPDATED
Fires when an asset is updated in Relayter and includes asset data and image files.
File data
When we send file data in the event, for instance for assets, we send a full file model with creation and modification dates, extension size and an temporary signed url where you can download the file.
Receiving data
After creating the event Relayter will POST the data on every event in your team to the URL you specified.
Authentication
We have 3 layers of security which you can use. The first is the Authentication token, which is a simple shared secret send via a http header. The next is using a secret, which is used to create a HMAC signature, preventing sending the secret over the internet. The last is timestamp verification. This prevents sending the same request more than once. We also add WebHook-Request-Origin header you could check if you want.
It is up to you (the consumer) which authentication you want to support, Relayter will send all the header to support the most strict authentication.
For more information about HMAC signatures:
Request details
Below an overview how Relayter sends the data to your consumer.
Method |
|
JSON Data location | Request Body |
Authentication token header |
|
Request origin header |
|
Content type header |
|
Signature header |
|
Signature hashing algoritm |
|
Signature encoding |
|
Timestamp header |
|