Webhook is used to send messages to the other party when events occur in Ellity. The other party can be your internal information system, business management system, email communication system, or generally a service that has an API. You can customize the message content according to the needs of the other party. You specify the other party by the URL at which the party receives messages.

Events

• Change customer account
• Change the VIP level of the customer
• Other according to client's requirement

Message settings

Go to Settings - Integration - Webhooks. If you haven't added the Webhooks feature yet, add it. You can now add webhooks. Add a webhook and open it.

1. You have the option to enable or temporarily disable sending.
2. Select the trigger, this is the event at which the message is to be sent
3. Enter the URL of the other party
4. If necessary, fill in the content of the message.

URL and message content

You can use variables in the URL and message content that are replaced with data when sent. Each event has different data. If you use a variable that is not present in the event, an empty value ("") is sent. You specify the variable in the format #name# and you have the following example:

• customer.id - customer id
• customer.email - customer email
• customer.credit - customer account
• customer.group.id - customer group id
• customer.group.name - group name
• customer.tier.id - customer VIP level id
• customer.tier.name - name of the VIP tier
• creditChange.value - value of the account change
• account.eshopId - e-shop id
• and more by pressing the Insert Variable button below the body of the message (you have to type the variable manually in the URL).

To add a variable as a URL parameter, insert it as follows:

https://domena_druhe_strany/cesta?id=#customer.id#&email=#customer.email#
https://domena_druhe_strany/cesta/#customer.id#

The message content must be written in JSON format, here is an example:

{
   "eshop":"#account.eshopId#",
   "email":"#customer.email#",
   "credit":"#customer.credit#",
   "custom": {
      "field":"vlastni_pole"
   }
}

If you need to authorize sending a message, please use the URL parameter with the API key value. If the other party requires authentication via HTTP headers (Authorize, etc.), please contact our technical support.

Tailor-made integration

Tailored solutions for your unique needs

At Ellity, we understand that every business is unique with its own specific needs. That's why we've developed a bespoke Integration service - a key solution for your specific requirements that we can't cover with our standard offerings.