Create a webhook to interface a third-party system with Particeep
What is a webhook?
A webhook is a way to call a third-party application (a web service) when a defined action has been taken.
For example, you can trigger the activation of a webhook when a new contact is created on your platform or when a new subscription is made.
How to create a Webhook?
- Connect to the back office of your platform,
- Go to the "Webhook" menu.
- Click on create,
- Enter the function of your webhook, i.e. what action the webhook will retrieve, you can find some examples here,
- Assign a dedicated URL to the chosen value.
For example:
I fill in the URL https://webhook.site/5709cd30-626e-4ef0-b4ec-829264226636 and the value "user_deleted" in order to receive information related to the deletion of an account.
After deleting a user on my platform, my test URL sent me a JSON code with all the information about the deletion of the account.
The JSON code generated via the webhook
{ "id": "8edb2113-ef0d-4d49-a45c-6a8ce9d77cd7", "created_at": "2018-02-19T17:18:39Z", "email": "charles.beaufils2@particeep.com", "has_been_claimed": false, "custom": { "ips": [{ "date": "2018-02-19 17:18:37.314+0000", "ip": "92.154.55.100", "action": "signin" }] }, "address": {} }