Tuemilio Documentation

Webhooks

Webhooks allow you to subscribe to certain events on Tuemilio. After adding a webhook URL, we'll ping you each time a user leaves an email.

new-subscriber Event

Each time you get a new subscriber we will send a post request to your app. Check the documentation on how to configure this webhook here.

POST /example HTTP/1.1
Host: example.com
User-Agent: Tuemilio-Hookshot/1.0
Content-Type: application/json
X-Tuemilio-Event: new-subscriber
{
   "event": "new-subscriber",
   "id": 232424,
   "address": "child@gmail.com",
   "ip": "192.168.10.1",
   "position": 2,
   "people_ahead": 15782,
   "position_ordinal": "15783rd",
   "points": 0,
   "anti_points": 0,
   "source": "email-form",
   "referrer_id": 232423,
   "referrer_url": null,
   "subscribed": 1,
   "dashboard_link": "https://mysite.com?email=child@gmail.com",
   "referral_link": "https://mysite.com?r=LZwZy",
   "referral_id": "LZwZy"
   "created_at": "2020-10-14 09:22:29",
   "blocked": 0,
   "fraud_id": null,
   "custom_fields": [],
   "shared_on": [],
   "subscribers_count": 2,
   "referrer": {
      "id": 232423,
      "address": "parent@gmail.com",
      "ip": "192.168.10.1",
      "points": 1,
      "anti_points": 1,
      "source": "email-form",
      "referrer_id": 0,
      "referrer_url": "https://mysite.com",
      "subscribed": 1,
      "click_time": 6,
      "cookie_uuid": "aa5b48b7-13bf-4e79-bac7-aaad5b973d05",
      "created_at": "2020-10-14 09:20:51",
      "blocked": 1,
      "fraud_id": 3,
      "custom_fields": [],
      "shared_on": [],
      "dashboard_link":"https://mysite.com?email=parent@gmail.com"
   },
   "waiters": [
      {
         "address": "xx@xx.com",
         "points": 1,
         "deleted_at": null,
         "position": 1
      },
      {...}
   ]
}

grant-access Event

Automatic webhooks sent from Tuemilio as configured for granting access from your app to your subscribers. Check the documentation on how to configure the frequency to give access and the number of users per batch here.

POST /example HTTP/1.1
Host: example.com
User-Agent: Tuemilio-Hookshot/1.0
Content-Type: application/json
X-Tuemilio-Event: grant-access
{
   "event": "grant-access",
   "id": 232424,
   "address": "child@gmail.com",
   "ip": "192.168.10.1",
   "position": 2,
   "points": 0,
   "anti_points": 0,
   "source": "email-form",
   "referrer_id": 232423,
   "referrer_url": null,
   "subscribed": 1,
   "dashboard_link": "https://mysite.com?email=child@gmail.com",
   "referral_link": "https://mysite.com?r=LZwZy",
   "referral_id": "LZwZy"
   "created_at": "2020-10-14 09:22:29",
   "blocked": 0,
   "fraud_id": null,
   "custom_fields": [],
   "shared_on": [],
   "subscribers_count": 2,
   "referrer": {
      "id": 232423,
      "address": "parent@gmail.com",
      "ip": "192.168.10.1",
      "points": 1,
      "anti_points": 1,
      "source": "email-form",
      "referrer_id": 0,
      "referrer_url": "https://mysite.com",
      "subscribed": 1,
      "click_time": 6,
      "cookie_uuid": "aa5b48b7-13bf-4e79-bac7-aaad5b973d05",
      "created_at": "2020-10-14 09:20:51",
      "blocked": 1,
      "fraud_id": 3,
      "custom_fields": [],
      "shared_on": [],
      "dashboard_link":"https://mysite.com?email=parent@gmail.com"
   },
   "waiters": [
      {
         "address": "xx@xx.com",
         "points": 1,
         "deleted_at": null,
         "position": 1
      },
      {...}
   ]
}

confirmed-subscriber Event

When subscribers confirm their email, we will send a post request to your app. Check the documentation on how to configure this webhook here.

WARNING

This webhook only fires when the confirmation email automation is enabled.

POST /example HTTP/1.1
Host: example.com
User-Agent: Tuemilio-Hookshot/1.0
Content-Type: application/json
X-Tuemilio-Event: confirmed-subscriber
{
   "event": "confirmed-subscriber",
   "id": 232424,
   "address": "child@gmail.com",
   "ip": "192.168.10.1",
   "position": 2,
   "people_ahead": 15782,
   "position_ordinal": "15783rd",
   "points": 0,
   "anti_points": 0,
   "source": "email-form",
   "referrer_id": 232423,
   "referrer_url": null,
   "subscribed": 1,
   "click_time": 17,
   "cookie_uuid": "559d768a-702b-4e81-8c26-6279195c840a",
   "uuid": "f7dbf56a-c0fb-4d09-958e-313850cacd87",
   "dashboard_link": "https://mysite.com?email=child@gmail.com",
   "referral_link": "https://mysite.com?r=LZwZy",
   "referral_id": "LZwZy"
   "created_at": "2022-03-18T01:58:18.000000Z",
   "blocked": 0,
   "fraud_id": null,
   "custom_fields": [],
   "shared_on": [],
   "subscribers_count": 2,
   "referrer": {
      "id": 232423,
      "address": "parent@gmail.com",
      "ip": "192.168.10.1",
      "points": 1,
      "anti_points": 1,
      "source": "email-form",
      "referrer_id": 0,
      "referrer_url": "https://mysite.com",
      "subscribed": 1,
      "click_time": 6,
      "cookie_uuid": "aa5b48b7-13bf-4e79-bac7-aaad5b973d05",
      "created_at": "2021-05-02T16:37:00.000000Z",
      "blocked": 1,
      "fraud_id": 3,
      "custom_fields": [],
      "shared_on": [],
      "dashboard_link":"https://mysite.com?email=parent@gmail.com",
      "dashboard_link_uuid": "https://mysite.com?uuid=e2e1fe20-157b-4970-97a0-73f6c5417c9c",
      "referral_link": "https://mysite.com?r=oQMGA",
      "verified_at": null,
      "browser": "",
      "operating_system": "",
      "device": "",
      "consents": [],
   },
   "waiters": [
      {
         "address": "xx@xx.com",
         "points": 1,
         "deleted_at": null,
         "position": 1
      },
      {...}
   ]
}

←