+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.

Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS

Create Webhook

Sie sind hier:

Creates a webhook in the newsletter account.

Warning: Custom contact fields are currently not supported properly and will be fixed.

POST https://api.maileon.com/1.0/webhooks

Values for „event“

Value Description
doi As soon as a double-opt-in link is clicked and DOI is confirmed the first time, this webhook will be triggered. If the account is set up for allowing to send DOI mails, even if a valid DOI permission is available, also the first time a DOI confirmation link in further DOI mails is clicked will be triggering the webhook.
unsubscription When a contact unsubscribes from the contact list and gets anonymized, this event will be fired.
bounce Whenever a bounce event is registered, this will be forwarded.
filtered If a personalization error during mail generation is registered, which prevents a mail from being sent, external systems can be notified. This usually happens, if there is a misconfiguration in the template, e.g. it expects a first name and defines no fallback and provided contact data contains no firstname for a given contact.
contact_field_change A change of contact field value event is triggered when clicking on the profile update link or, if „Contact field change on unsubscription“ is activated, by unsubscribing. Other changes will not be triggering the webhook.

Example

Request

POST https://api.maileon.com/1.0/webhooks
Authorization: Basic: XXXXXXXXXXXXXXXX
Content-Type: application/json

{
  "url": "https://hosting.maileon.com/service/examples/en/webhooks_catch_example/webhook.php",
  "event": "unsubscription",
  "urlParams": [
    {
      "custom_contact_field": null,
      "standard_contact_field": "email",
      "custom_value": null,
      "name": "email"
    },
    {
      "custom_contact_field": null,
      "standard_contact_field": "external_id",
      "custom_value": null,
      "name": "eid"
    }
  ],
  "customFields": [],
  "standardFields": [
    "email",
    "external_id"
  ],
  "eventFields": [
    "msg_id",
    "method"
  ]
}

Response

Status 201 Created
<id>1915</id>
Inhaltsverzeichnis