Skip to content

Webhooks

Managers are allowed to register Webhooks to receive events for all transactional email sent, from the configuration page of the Transactional service on opper MarketingSuite dashboard.

Events

All event messages are JSON objects containing the following fields :

  • event : Type of event
  • date : Date of the event
  • ts_epoch : Timestamp (in milliseconds) of the event
  • message-id : ID of the message
  • subject : Subject of the message
  • tags : List if tags applied on the transactional email

Sent event

This event occurs when the email has been sent

Additional fields in event :

  • mirror_link : URL of the preview of the message

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "request",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "mirror_link": "https://mirror.ownpage.fr/clients/abcdef/transactional/67e568a13d1c0f0001273212.html"
}

Delivered event

This event occurs when the email has been delivered

Additional fields in event :

  • email : Email address to which the email was delivered

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "delivered",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "email": "email@domain.com"
}

First Opened event

This event occurs when the email has been opened the first time

Additional fields in event :

  • user_agent : User-Agent from which the email was opened

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "unique_opened",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "user_agent": "User-Agent"
}

Opened event

This event occurs when the email has been opened for the second time (or more)

Additional fields in event :

  • user_agent : User-Agent from which the email was opened

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "opened",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "user_agent": "User-Agent"
}

Clicked event

This event occurs when the recipient has clicked on a link in the email

Additional fields in event :

  • link : URL of the clicked link
  • user_agent : User-Agent from which the email was clicked

Example :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "event": "click",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "link": "https://link.com",
    "user_agent": "User-Agent"
}

Invalid Email event

This event occurs when the email could not be sent due to an invalid email address

Additional fields in event :

  • message : Details message

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "invalid_email",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "message": "Invalid email message"
}

Error event

This event occurs when the email could not be sent due to an error

Additional fields in event : - message : Error message

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "error",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "message": "Error message"
}

Soft Bounce event

This event occurs when the email could not be delivered due to a 'soft' bounce

Additional fields in event :

  • email : Email address from which a bounce was received
  • message : Bounce message

Example :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "event": "soft_bounce",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "email": "email@domain.com",
    "message": "Bounce message"
}

Hard Bounce event

This event occurs when the email could not be delivered due to a 'hard' bounce

Additional fields in event :

  • email : Email address from which a bounce was received
  • message : Bounce message

Example :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "event": "hard_bounce",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "email": "email@domain.com",
    "message": "Bounce message"
}

Complaint event

This event occurs when a Spam complaint has been received for the email

Additional fields in event :

  • email : Email address from which a complaint was received

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "spam",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "email": "email@domain.com"
}

Unsubscribed event

Not applicable for now

Blocked event

This event occurs when the email could not be delivered due to recipients registered in blacklist (known for hard-bounce or complaint)

Additional fields in event :

  • message : Details message

Example :

1
2
3
4
5
6
7
8
9
{
    "event": "blocked",
    "date": "2025-03-27 15:20:16 UTC",
    "ts_epoch": 1743088816000,
    "message-id": "67e568a13d1c0f0001273212",
    "subject": "Subject",
    "tags": ["Test"],
    "message": "Recipients are in blacklist"
}

Comments