{"id":96802,"date":"2019-06-27T06:14:50","date_gmt":"2019-06-27T06:14:50","guid":{"rendered":"https:\/\/mailrelay.com\/blog\/2026\/09\/29\/mailrelay-v3-webhooks-to-connect-with-external-systems\/"},"modified":"2026-09-29T19:12:23","modified_gmt":"2026-09-29T19:12:23","slug":"mailrelay-v3-webhooks-to-connect-with-external-systems","status":"publish","type":"post","link":"https:\/\/mailrelay.com\/en\/blog\/2019\/06\/27\/mailrelay-v3-webhooks-to-connect-with-external-systems\/","title":{"rendered":"Mailrelay v3 Webhooks to Connect with External Systems"},"content":{"rendered":"

We have recently added a new feature to the new version of Mailrelay, webhooks.<\/strong><\/p>\n

Webhooks complement sending via API or SMTP services<\/a> to integrate Mailrelay with your external systems.<\/p>\n

Webhooks allow real-time connections with external systems,<\/strong> and you can currently define them for:<\/p>\n

    \n
  1. When a subscriber is added to a group<\/li>\n
  2. When they are removed from the group<\/li>\n
  3. Or when they unsubscribe<\/li>\n<\/ol>\n

    What can we use these webhooks for?<\/strong><\/p>\n

    Here is a very simple example: imagine your company manages all its contacts and customers in its own CRM, where it keeps all their data, previous purchases, etc. And to send them email campaigns, your company exports these contacts and imports them into Mailrelay, and sends from there.<\/p>\n

    The problem, until now, was that although in Mailrelay contacts can unsubscribe through the links in the newsletter, to unsubscribe them in the CRM (or another external system)<\/em> you had to use the API or do it manually.<\/p>\n

    With the new webhooks option it is easier<\/strong> to send a request and handle it programmatically on the CRM side.<\/p>\n

    In this post we will see how to define and test webhooks.<\/p>\n<\/p>\n

    \u00b7 Defining a webhook for unsubscribes<\/h2>\n

    Webhooks are defined in the Automations<\/strong> section:<\/p>\n

    \"Mailrelay<\/p>\n

    Once in this section, we will create a new automation:<\/p>\n

    \"new<\/p>\n

    The automation we are going to create is of the \u201ccustom\u201d<\/strong> type (the other option is birthday, but we are not interested in that one right now):<\/p>\n

    \"create<\/p>\n

    From here we will need to do the basic setup of the automation.<\/p>\n

    We will go over the most important parameters after the following image:<\/p>\n

    \"Mailrelay<\/p>\n

    We have these options:<\/p>\n

      \n
    1. Name:<\/strong> this is just the internal name of the trigger, you can call it whatever you like<\/li>\n
    2. All subscribers:<\/strong> we could define a specific group, but for this example I am selecting all of them<\/li>\n<\/ol>\n

      After setting those, we will need to \u201cAdd trigger\u201d<\/strong>, to define the action that will fire the event.<\/p>\n

      We will choose the \u201cSubscriber Activity\u201d<\/strong> option:<\/p>\n

      \"webhook<\/p>\n

      Among all the subscriber activity options we have:<\/p>\n

      \"contact<\/p>\n

      We will use the unsubscribe event<\/strong>, which is the one we are interested in at the moment, but it would be possible to define events for when a subscriber is added to a group, or is removed from a group (without unsubscribing):<\/p>\n

      \"webhook<\/p>\n

      We will give the trigger whatever name we want and, something important:<\/strong><\/p>\n

        \n
      1. Webhook url<\/strong>: that is, the URL the request will be sent to when a contact’s unsubscribe is processed.<\/li>\n
      2. The request is normally sent in the GET array, not in the POST array<\/li>\n<\/ol>\n

        The webhook’s destination URL is a URL on our website where we can receive the information sent by Mailrelay, with details of the contact who has unsubscribed, and process that information however we need.<\/p>\n

        Once that is done, all that is left is to Validate and apply:<\/strong><\/p>\n

        \"validate<\/p>\n

        And finally, to create the whole automation, click the \u201ccreate automation\u201d<\/strong> button:<\/p>\n

        \"create<\/p>\n

        That way everything will be ready, and all that is left is for the CRM or software side to handle the calls that will be fired whenever an unsubscribe occurs.<\/p>\n

        \"Mailrelay<\/a><\/p>\n

        \u00b7 Testing the webhook with testing tools<\/h2>\n

        You may want to test the webhook before you have the programming on your software’s side in place; for that you can use a service such as RequestBin:<\/p>\n

        \"requestbin\"<\/p>\n

        On this screen you just need to click the \u201cCreate a RequestBin\u201d<\/strong> button. I also recommend creating it as private.<\/p>\n

        Once that is done, you will see a screen similar to the following one:<\/p>\n

        \"requestbin<\/p>\n

        You can copy that URL and paste it when you are creating the webhook:<\/p>\n

        \"creating<\/p>\n

        We just need to put the URL in the form field, and then we can launch a test with the \u201cTest webhook\u201d<\/strong> button:<\/p>\n

        \"launching<\/p>\n

        If we accept the message the webhook will be sent, and we will be able to see the request in RequestBin<\/strong>:<\/p>\n

        \"requestbin\"<\/p>\n

        It is a sample request, but it has the same structure as a real one:<\/p>\n

        {\u00abunsubscribe_event\u00bb:{\u00absource\u00bb:\u00bbweb\u00bb,\u00bbip\u00bb:\u00bb192.168.1.1\u2033,\u00bbemail\u00bb:\u00bbuser@example.com\u00bb,\u00bbreason\u00bb:null,
        \u00abdescription\u00bb:null,\u00bbcreated_at\u00bb:\u00bb2019-06-14T10:48:41.510+02:00\u2033},
        \u00abtime\u00bb:\u00bb2019-06-14T10:48:41.511+02:00\u2033,\u00bbautomation_trigger_id\u00bb:0,\u00bbsubscriber\u00bb:{\u00abid\u00bb:null,\u00bbemail\u00bb:\u00bbuser@example.com\u00bb,
        \u00abname\u00bb:null,\u00bbscore\u00bb:null,\u00bbstatus\u00bb:\u00bbinactive\u00bb,
        \u00absubscribed_at\u00bb:null,\u00bbsubscribed_with_acceptance\u00bb:false,\u00bbsubscribe_ip\u00bb:null,
        \u00abunsubscribed\u00bb:false,\u00bbunsubscribed_at\u00bb:null,\u00bbunsubscribe_ip\u00bb:null,
        \u00abunsubscribe_sent_email_id\u00bb:null,\u00bbaddress\u00bb:null,\u00bbcity\u00bb:null,\u00bbstate\u00bb:null,
        \u00abcountry\u00bb:null,\u00bbbirthday\u00bb:null,\u00bbwebsite\u00bb:null,\u00bbbounced\u00bb:false,\u00bbreported_spam\u00bb:false,
        \u00ablocal_ban\u00bb:false,\u00bbglobal_ban\u00bb:false,\u00bbcreated_at\u00bb:\u00bb2019-06-14T10:48:41.507+02:00\u2033,\u00bbupdated_at\u00bb:\u00bb2019-06-14T10:48:41.507+02:00\u2033,
        \u00abcustom_fields\u00bb:{}}}<\/p>\n

        That way you can learn its structure and handle it in your own system.<\/p>\n

        You can also make real requests<\/strong> if you save the automation and trigger a real unsubscribe.<\/p>\n

        You will see those in RequestBin, but this time with the contact’s real information.<\/p>\n

        \"Automations<\/p>\n

        Related posts:<\/p>\n