Use Cases Integrations
api marketing
November 25, 2022
Webhook Events API
Learn about each event types, the triggering actions in E-goi, and each event's unique properties.

About Webhook Events API

The Webhooks Events API allows you to subscribe to events happening in your E-goi account, we will send you an HTTP request to an endpoint you configure every time that event is triggered in E-goi.

Note: Only http or https protocols are supported in the Url parameter.

You can configure all the following events in our API. Documentation

Event Description
forget_subscription Triggered when a contact requests is subscription to be forgotten
change_consent Triggered when a contact changes is consent within the subscribed list
web_push_bounce Triggered when a web push message bounces for a contact
web_push_click Triggered when a web push message is clicked by a contact
web_push_delivered Triggered when a web push message is delivered to a contact
web_push_open Triggered when a web push messages is opened by a contact
web_push_send Triggered when a web push messages is sent to a contact
web_push_subscription Triggered when a a contact subscribes to web push messages in you list
web_push_unsubscription Triggered when a a contact unsubscribes to web push messages in you list
email_send Triggered when a email message is sent to a contact
email_open Triggered when a email message is opened by a contact
email_click Triggered when a email message is clicked by a contact
email_soft_bounce Triggered when a email message sent to a contact soft bounces
email_hard_bounce Triggered when a email message sent to a contact hard bounces
sms_send Triggered when a sms message is sent to a contact
sms_delivered Triggered when a email message is delivered to a contact
voice_send TTriggered when a voice message is sent to a contact
unsubscribe Triggered when a contact unsubscribes a list
subscription Triggered when a contact subscribes a list
edit_subscription Triggered when a contact edits is subscription on a list
resubscription Triggered when a removed contact subscribes an unsubscribed list
facebook_like Triggered when a contact likes your message in facebook
social_share Triggered when a contact shares your message
double_optin Triggered when a contact confirms the subscription
email_spam_complaint Triggered when a contact spam complains
email_field_disable Triggered when a contact disables an email field
cellphone_field_disable Triggered when a contact disables an cellphone field
phone_field_disable Triggered when a contact disables an phone field
push_send Triggered when a push message is sent to a contact
push_open Triggered when a push message is opened by a contact
push_click Triggered when a push message is clicked by a contact
push_received Triggered when a push message is received by a contact
push_error Triggered when a push message has a problem sending
push_canceled Triggered when a push message is canceled
new_order Triggered when a new ecommerce order has been placed by a contact
cart_update Triggered when a contact has a cart update
goal_conversion Triggered when a contact reaches a goal in Track and Engage
product_view Triggered when a contact views a product

The Webhooks Events API can return different types of events triggered by activity on E-goi. Each event response contains shared properties, but has a unique payload object determined by its event type.

The Event object common properties describes the properties shared by all events, and each event type describes the payload properties that are unique to the specific event.

Note that E-goi will allways send an array of objects containing multiple events that occurred for that specific webhook configuration.

Example:

{
  "events": [
    ....
  ]
}

Event object common properties

The event objects returned from the Events API endpoints have the same structure.

Attribute name Property’s Description
action The type of event. Events uses snake case for the name.
action_date Timestamp in wish the event occurred.
action_data Object with important information about the event. One of messageHash, order, goal, cart or product_id.
One of .messageHash Campaign hash that triggered the event.
One of .order Order id that triggered the event.
One of .goal Goal id that triggered the event.
One of .cart Cart id that triggered the event.
One of .product_id Product id that triggered the event.
list_id Id of the list that triggered the event.
contact Object with the contact information that triggered the event. All Of base and fields
All of .base Array with the contact id that triggered the event.
All of .fields Array with the contact fields supplied in createWebhook and according to getAllFields spec, empty if none.

Example:

{
  "events": [
    {
      "action": "email_send",
      "action_date": 631152000,
      "action_data": {
        "messageHash": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
      },
      "list_id": "1",
      "contact": {
        "base": [
          "a1a1a1a1a1"
        ],
        "fields": [
          {
            "uid": "a1a1a1a1a1",
            "email": "john_doe@email.com",
            "cellphone": "999-999999999",
            "name": "John",
            "last_name": "Doe"
          }
        ]
      }
    },
    {
      "action": "sms_send",
      "action_date": 631152000,
      "action_data": {
        "messageHash": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
      },
      "list_id": "1",
      "contact": {
        "base": [
          "a1a1a1a1a1"
        ],
        "fields": [
          {
            "uid": "a1a1a1a1a1",
            "email": "john_doe@email.com",
            "cellphone": "999-999999999",
            "name": "John",
            "last_name": "Doe"
          }
        ]
      }
    }
  ]
}