Webhooks
ขออภัย บทความนี้ไม่มีฉบับที่เขียนด้วยภาษาของคุณ

A webhook is a lightweight way for an application to pass on information to other apps. They provide the potential to receive real-time updates about your contacts & campaign activity.

The purpose of this section is to explain how to use webhooks in Taximail so you can get updates in near real-time.

  • It could mean like notifying a private application developed just for you.
  • It could also mean something like a way to notify another 3rd party application that accepts POST requests.
  • It is simply a user-defined callback in the form of an HTTP POST.
  • It is invoked when something happens.

Working with Webhooks

For example, when someone subscribes to one of your lists, you might like the data about that subscription to be made available to another application. You can do this by simply specifying a URL to which that data should be sent when the subscription occurs.

List events

Subscribe

Example for JSON

{
    "action_type": "Subscribe",
    "action_timestamp": 1606188652,
    "subscriber": {
        "send_mode": "List",
        "list_name": "My List 1",
        "subscriber_id": 1,
        "email": "example@example.com",
        "msisdn": "66123456789",
        "bounce_type": "Not Bounced",
        "subscription_status": "Subscribed",
        "subscription_date": "2020-10-24 10:30:51",
        "subscription_ip": "",
        "unsubscription_date": "",
        "unsubscription_ip": "",
        "opt_in_date": "",
        "device": null,
        "list_id": "1",
        "source": "import"
    }
}

Example for XML


<webservice>
   <action_type>![CDATA[Subscribe]]</action_type>
   <action_timestamp>![CDATA[1606369471]]</action_timestamp>
   <subscriber>
      <send_mode>![CDATA[List]]</send_mode>
      <list_name>![CDATA[My List 1]]</list_name>
      <subscriber_id>![CDATA[1]]</subscriber_id>
      <email>![CDATA[example@example.com]]</email>
      <msisdn>![CDATA[66123456789]]</msisdn>
      <bounce_type>![CDATA[Not Bounced]]</bounce_type>
      <subscription_status>![CDATA[Subscribed]]</subscription_status>
      <subscription_date>![CDATA[2020-10-24 10:30:51]]</subscription_date>
      <subscription_ip>![CDATA[]]</subscription_ip>
      <unsubscription_date>![CDATA[]]</unsubscription_date>
      <unsubscription_ip>![CDATA[]]</unsubscription_ip>
      <opt_in_date>![CDATA[]]</opt_in_date>
      <device>![CDATA[]]</device>
      <list_id>![CDATA[2]]</list_id>
      <source>![CDATA[import]]</source>
   </subscriber>
</webservice>

Unsubscribe

Example for JSON

{
    "action_type": "Unsubscribe",
    "action_timestamp": 1606274536,
    "subscriber": {
        "send_mode": "List",
        "list_name": "My List 1",
        "subscriber_id": 1,
        "email": "example@example.com",
        "msisdn": "66123456789",
        "bounce_type": "Not Bounced",
        "subscription_status": "Unsubscribed",
        "subscription_date": "2020-10-24 10:30:51",
        "subscription_ip": "",
        "unsubscription_date": "2020-10-25 10:22:16",
        "unsubscription_ip": "*.*.*.*",
        "opt_in_date": "2020-10-05 19:11:48",
        "campaign_ref_tag": "CAMPAIGN-WEBHOOK",
        "campaign_id": 1,
        "device": "OTHER",
        "list_id": 1,
        "source": "campaign"
    }
}

Example for XML


<webservice>
   <action_type>![CDATA[Unsubscribe]]</action_type>
   <action_timestamp>![CDATA[1606374294]]</action_timestamp>
   <subscriber>
      <send_mode>![CDATA[List]]</send_mode>
      <list_name>![CDATA[My List 1]]</list_name>
      <subscriber_id>![CDATA[1]]</subscriber_id>
      <email>![CDATA[example@example.com]]</email>
      <msisdn>![CDATA[]]</msisdn>
      <bounce_type>![CDATA[Not Bounced]]</bounce_type>
      <subscription_status>![CDATA[Unsubscribed]]</subscription_status>
      <subscription_date>![CDATA[2020-10-24 10:30:51]]</subscription_date>
      <subscription_ip>![CDATA[]]</subscription_ip>
      <unsubscription_date>![CDATA[2020-10-25 10:22:16]]</unsubscription_date>
      <unsubscription_ip>![CDATA[*.*.*.*]]</unsubscription_ip>
      <opt_in_date>![CDATA[2020-10-05 19:11:48]]</opt_in_date>
      <device>![CDATA[OTHER]]</device>
      <list_id>![CDATA[1]]</list_id>
      <source>![CDATA[campaign]]</source>
   </subscriber>
</webservice>

Campaign events

Open

Example for JSON

{
    "action_type": "open",
    "email": "example@example.com",
    "msisdn": "66123456789",
    "source": "campaign",
    "device": "PERSONAL COMPUTER",
    "campaign_ref_tag": "WEBHOOK-CAMPAIGN",
    "campaign_id": 1,
    "campaign_name": "WEBHOOK-CAMPGIN",
    "datetime": "2020-10-26 14:51:21"
}

Example for XML


<webservice>
   <action_type>![CDATA[open]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[66123456789]]</msisdn>
   <source>![CDATA[campaign]]</source>
   <device>![CDATA[PERSONAL COMPUTER]]</device>
   <campaign_ref_tag>![CDATA[WEBHOOK-CAMPAIGN]]</campaign_ref_tag>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[WEBHOOK-CAMPGIN]]</campaign_name>
   <datetime>![CDATA[2020-10-26 14:51:21]]</datetime>
</webservice>

Click

Example for JSON

{
    "action_type": "click",
    "email": "example@example.com",
    "msisdn": "66123456789",
    "source": "campaign",
    "device": "PERSONAL COMPUTER",
    "campaign_ref_tag": "WEBHOOK-CAMPAIGN",
    "campaign_id": 1,
    "campaign_name": "WEBHOOK-CAMPGIN",
    "url": "https://www.example.com",
    "datetime": "2020-10-26 14:52:10"
}

Example for XML


<webservice>
   <action_type>![CDATA[click]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[66123456789]]</msisdn>
   <source>![CDATA[campaign]]</source>
   <device>![CDATA[PERSONAL COMPUTER]]</device>
   <campaign_ref_tag>![CDATA[WEBHOOK-CAMPAIGN]]</campaign_ref_tag>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[WEBHOOK-CAMPGIN]]</campaign_name>
   <url>![CDATA[https://www.example.com]]</url>
   <datetime>![CDATA[2020-10-26 14:52:10]]</datetime>
</webservice>

Bounce

Example for JSON

{
    "action_type": "bounce",
    "email": "example@example.com",
    "msisdn": "",
    "source": "campaign",
    "campaign_ref_tag": "WEBHOOK-CAMPAIGN",
    "campaign_id": 1,
    "campaign_name": "WEBHOOK-CAMPAIGN",
    "bounce_type": "Hard",
    "bounce_id": 20,
    "bounce_case": "Domain name does not exist",
    "datetime": "2020-10-25 12:10:06"
}

Example for XML


<webservice>
   <action_type>![CDATA[bounce]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[]]</msisdn>
   <source>![CDATA[campaign]]</source>
   <campaign_ref_tag>![CDATA[WEBHOOK-CAMPAIGN]]</campaign_ref_tag>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[WEBHOOK-CAMPAIGN]]</campaign_name>
   <bounce_type>![CDATA[Hard]]</bounce_type>
   <bounce_id>![CDATA[20]]</bounce_id>
   <bounce_case>![CDATA[Domain name does not exist]]</bounce_case>
   <datetime>![CDATA[2020-10-25 12:10:06]]</datetime>
</webservice>

Spam complaint

Example for JSON

{
    "action_type": "spam compaint",
    "email": "example@example.com",
    "msisdn": "",
    "source": "campaign",
    "device": "OTHER",
    "campaign_ref_tag": "WEBHOOK-CAMPAIGN",
    "campaign_id": 1,
    "campaign_name": "WEBHOOK-CAMPAIGN",
    "datetime": "2020-10-25 10:22:43"
}

Example for XML


<webservice>
   <action_type>![CDATA[spam compaint]]</action_type>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[WEBHOOK-CAMPAIGN]]</campaign_name>
   <campaign_ref_tag>![CDATA[WEBHOOK-CAMPAIGN<]]/campaign_ref_tag>
   <datetime>![CDATA[2020-10-25 10:22:43]]</datetime>
   <device>![CDATA[OTHER]]</device>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[]]</msisdn>>
   <source>![CDATA[campaign]]</source>
</webservice>

Transactional events

Open

Example for JSON

{
    "message_id": "9273cea1-02c8-4e26-883b-38c2ad466878",
    "action_type": "open",
    "email": "example@example.com",
    "msisdn": "66123456789",
    "source": "transactional",
    "device": "PERSONAL COMPUTER",
    "source_transaction": "api",
    "campaign_id": 1,
    "campaign_name": "WEBHOOK-CAMPAIGN",
    "datetime": "2020-10-25 14:13:00"
}

Example for XML


<webservice>
   <message_id>![CDATA[9273cea1-02c8-4e26-883b-38c2ad466878]]</message_id>
   <action_type>![CDATA[open]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[66123456789]]</msisdn>
   <source>![CDATA[transactional]]</source>
   <device>![CDATA[PERSONAL COMPUTER]]</device>
   <source_transaction>![CDATA[api]]</source_transaction>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[WEBHOOK-CAMPAIGN]]</campaign_name>
   <datetime>![CDATA[2020-10-25 14:13:00]]</datetime>
</webservice>

Click

Example for JSON

{
    "message_id": "9479e21c-6758-4132-bd27-fbb4029f0876",
    "action_type": "click",
    "email": "example@example.com",
    "msisdn": "66123456789",
    "source": "transactional",
    "device": "PERSONAL COMPUTER",
    "source_transaction": "api",
    "campaign_id": 1,
    "campaign_name": "WEBHOOK-TRASACTIONAL",
    "url": "http://www.example.com",
    "datetime": "2020-10-25 14:15:12"
}

Example for XML


<webservice>
   <message_id>![CDATA[9479e21c-6758-4132-bd27-fbb4029f0876]]</message_id>
   <action_type>![CDATA[click]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[66123456789]]</msisdn>
   <source>![CDATA[transactional]]</source>
   <device>![CDATA[PERSONAL COMPUTER]]</device>
   <source_transaction>![CDATA[api]]</source_transaction>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[WEBHOOK-TRASACTIONAL]]</campaign_name>
   <url>![CDATA[http://www.example.com]]</url>
   <datetime>![CDATA[2020-10-25 14:15:12]]</datetime>
</webservice>

Bounce

Example for JSON

{
    "message_id": "4c9c3eb7-f464-4d93-ad96-b2ba447e6001",
    "action_type": "bounce",
    "email": "example@example.com",
    "msisdn": "",
    "source": "transaction",
    "source_transaction": "api",
    "campaign_id": 1,
    "bounce_type": "Hard",
    "bounce_id": 20,
    "bounce_case": "Domain name does not exist",
    "datetime": "2020-10-26 16:04:49"
}

Example for XML

<webservice>
    <message_id>![CDATA[4c9c3eb7-f464-4d93-ad96-b2ba447e6001]]</message_id>
    <action_type>![CDATA[bounce]]</action_type>
    <email>![CDATA[example@example.com]]</email>
    <msisdn>![CDATA[]]</msisdn>
    <source>![CDATA[transaction]]</source>
    <sosource_transactionurce>![CDATA[api]]</sosource_transactionurce>
    <campaign_id>![CDATA[1]]</campaign_id>
    <bounce_type>![CDATA[Hard]]</bounce_type>
    <bounce_id>![CDATA[20]]</bounce_id>
    <bounce_case>![CDATA[Domain name does not exist]]</bounce_case>
    <datetime>![CDATA[2020-10-26 16:04:49]]</datetime>
</webservice>

Spam complaint

Example for JSON

{
    "message_id": "f7d96358-f64f-4b3c-8a66-fb998a04a385",
    "action_type": "spam complain",
    "email": "example@example.com",
    "datetime": "2020-10-26 16:29:30",
    "source_transaction": "smtp",
    "device": "OTHER"
}

Example for XML


<webservice>
   <message_id>![CDATA[f7d96358-f64f-4b3c-8a66-fb998a04a385]]</message_id>
   <action_type>![CDATA[spam complain]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <datetime>![CDATA[2020-10-26 16:29:30]]</datetime>
   <source_transaction>![CDATA[smtp]]</source_transaction>
   <device>![CDATA[OTHER]]</device>
</webservice>

Automation events

Open

Example for JSON

{
    "message_id": "5fc0c486f5556d41063297e2",
    "action_type": "click",
    "email": "example@example.com",
    "msisdn": "",
    "source": "automation",
    "automation_id": 1,
    "device": "PERSONAL COMPUTER",
    "campaign_ref_tag": "AUTOMATION-WEBHOOK",
    "campaign_id": 1,
    "campaign_name": "AUTOMATION-CAMPAIGN",
    "url": "https:\/\/www.example.com",
    "datetime": "2020-10-27 16:23:33"
}

Example for XML


<webservice>
   <message_id>![CDATA[5fc0c486f5556d41063297e2]]</message_id>
   <action_type>![CDATA[click]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[]]</msisdn>
   <source>![CDATA[automation]]</source>
   <automation_id>![CDATA[1]]</automation_id>
   <device>![CDATA[PERSONAL COMPUTER]]</device>
   <campaign_ref_tag>![CDATA[AUTOMATION-WEBHOOK]]</campaign_ref_tag>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[AUTOMATION-CAMPAIGN]]</campaign_name>
   <url>![CDATA[https://www.example.com]]</url>
   <datetime>![CDATA[2020-10-27 16:23:33]]</datetime>
</webservice>

Bounce

Example for JSON

{
    "message_id": "5fc0c8be80c66a545e47d612",
    "action_type": "bounce",
    "email": "example@example.com",
    "msisdn": "",
    "source": "automation",
    "automation_id": 1,
    "campaign_id": 1,
    "campaign_name": "AUTOMATION-CAMPAIGN",
    "bounce_type": "Hard",
    "bounce_id": 20,
    "bounce_case": "Domain name does not exist",
    "datetime": "2020-10-27 16:37:08"
}

Example for XML


<webservice>
   <message_id>![CDATA[5fc0c8be80c66a545e47d612]]</message_id>
   <action_type>![CDATA[bounce]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[]]</msisdn>
   <source>![CDATA[automation]]</source>
   <automation_id>![CDATA[1]]</automation_id>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[AUTOMATION-CAMPAIGN]]</campaign_name>
   <bounce_type>![CDATA[Hard]]</bounce_type>
   <bounce_id>![CDATA[20]]</bounce_id>
   <bounce_case>![CDATA[Domain name does not exist]]</bounce_case>
   <datetime>![CDATA[2020-10-27 16:37:08]]</datetime>
</webservice>

Spam compaint

Example for JSON

{
    "message_id": "5fc0c5b2059d1875ea71f9f2",
    "action_type": "spam compaint",
    "email": "example@example.com",
    "msisdn": "",
    "source": "automation",
    "automation_id": 1,
    "device": "OTHER",
    "campaign_ref_tag": "AUTOMATION-WEBHOOK",
    "campaign_id": 1,
    "campaign_name": "AUTOMATION-CAMPAIGN",
    "datetime": "2020-10-27 16:41:43"
}

Example for XML


<webservice>
   <message_id>![CDATA[5fc0c5b2059d1875ea71f9f2]]</message_id>
   <action_type>![CDATA[spam compaint]]</action_type>
   <email>![CDATA[example@example.com]]</email>
   <msisdn>![CDATA[]]</msisdn>
   <source>![CDATA[automation]]</source>
   <automation_id>![CDATA[1]]</automation_id>
   <device>![CDATA[OTHER]]</device>
   <campaign_ref_tag>![CDATA[AUTOMATION-WEBHOOK]]</campaign_ref_tag>
   <campaign_id>![CDATA[1]]</campaign_id>
   <campaign_name>![CDATA[AUTOMATION-CAMPAIGN]]</campaign_name>
   <datetime>![CDATA[2020-10-27 16:44:39]]</datetime>
</webservice>
Title
Title SEO [Optional]
Description SEO [Optional]
Friendly URL [Optional]
IFRAME Content [Optional]
Priority
Markdown

เลือกภาษา

ภาษาไทย
English
เว็บไซต์นี้ใช้คุกกี้
เราใช้คุกกี้เพื่อเพิ่มประสิทธิภาพ และประสบการณ์ที่ดีในการใช้งานเว็บไซต์ คุณสามารถเลือกตั้งค่าความยินยอมการใช้คุกกี้ได้ โดยคลิก การตั้งค่าคุกกี้ หรืออ่านรายละเอียดเพิ่มเติมได้ที่ นโยบายคุกกี้
การตั้งค่าคุกกี้
ยอมรับทั้งหมด