Introduction

📘
Geeks ahoy!
Some technical knowledge about Webhooks will be useful when following this guide. If you need technical support, reach out to our support team for help.

Webhooks are a standard way of receiving near real-time notifications of when events happen in the Mention Me platform.

With the Webhook system, you can create Webhooks which will deliver events to external systems which you control. These external systems can then execute code of your choice whenever one or more events occur.

For instance, you may wish to update a customer record when a customer successfully refers their friend, send out an email when a customer receives a reward for referring, or apply credit to an account in real-time when a reward is received. All of which are great use cases for Webhooks.

Difference between Webhooks and APIs

Unlike our APIs, where your external systems are requesting data from us, Webhooks are a way in which you can receive data from us when events occur in real-time.

Basics

A Webhook is an HTTPS POST request to a URL of your choice, and any system which can accept a HTTPS request can be used to consume a Webhook from Mention Me.

Any request your external system receives will:

Be a HTTP POST request (over SSL).
Have data about an event which occurred in the body of the request. This data will be in the JSON format (you can see more in the Events section.
(Optionally, if a Secret was chosen set during setup) Have a HTTP Header with a signature for the webhook. This signature helps to validate the authenticity of the Webhook - you can read more in the Security section.