Getting Started

Taximail allows you to configure webhooks so you can get near real-time updates to your system that track with various user actions. To do so, you will need to configure the destination of the webhook. Then, Taximail will send you an HTTP/HTTPS request when any of those events are created.

Adding

• This API endpoint allows you to add a webhook to each list.
• In the first step, you have to set the webhooks_url and webhooks_type.
• In the following step, you need to send a POST request to list/{list_id}/webhooks API.
• The Taximail API will return webhooks_id and webhooks_status.

POST https://api.taximail.com/v2/list/{list_id}/webhooks

Example Request

POST v2/list/314/webhooks HTTP/1.1
Host: api.taximail.com

session_id=24bca90bac40b23e9fdcc8082299049d&webhooks_type=subscription&webhooks_url=https%3A%2F%2Fmy.webservice.com%2Fcallback_subscription

Example Result

{
  "status": "success",
  "code": 201,
  "data": {
              "webhooks_id": 49,
              "webhooks_status": "T"
       }
}

Fields

Response Code

Webhooks detail

• This API endpoint allows you to get details about webhooks.
• You can send GET request to list/{list_id}/webhooks API.

GET https://api.taximail.com/v2/list/{list_id}/webhooks

Example Request

GET v2/list/314/webhooks?session_id=24bca90bac40b23e9fdcc8082299049d HTTP/1.1
Host: api.taximail.com

Example Result

{
  "status": "success",
  "code": 200,
  "data": {
            "webhooks_mode": "custom",
            "webhooks_status": "enable",
            "urls": [
                  {
                        "webhooks_id": 45,
                        "webhooks_type": "subscription",
                        "url": "https://my.webservice.com/callback_subscription"
                  },
                  {
                        "webhooks_id": 46,
                        "webhooks_type": "unsubscription",
                        "url": "https://my.webservice.com/callback_unsubscription"
                  }
            ]
       }
}

Fields

Response Code

Deleting

• This API endpoint allows you to delete webhooks.
• You need to send DELETE request to list/{list_id}/webhooks/{webhooks_id} API.

DELETE https://api.taximail.com/v2/list/{list_id}/webhooks/{webhooks_id}

Example Request

DELETE v2/list/314/webhooks?session_id=24bca90bac40b23e9fdcc8082299049d HTTP/1.1
Host: api.taximail.com

Example Result

{
  "status": "success",
  "code": 200
}

Fields

Response Code