Événements de campagne

Campagnes créées, modifiées, programmées, envoyées, annulées, archivées ou supprimées.

campaign.created
campaign.updated
campaign.scheduled
campaign.queued
campaign.sending
campaign.sent
campaign.canceled
campaign.archived
campaign.deleted

campaign.created

Envoyé lorsqu’une campagne est créée avec Créer une campagne ou dans le tableau de bord, y compris lorsque vous dupliquez une campagne. Les nouvelles campagnes démarrent au statut draft.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

ID de l’événement (evt_…). Une requête relancée porte le même ID : utilisez-le pour ignorer les événements déjà traités. Vous pouvez aussi consulter l’événement avec Récupérer un événement.

typestring

Toujours campaign.created.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours draft.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.created",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00"
    }
  }
}

campaign.updated

Envoyé lorsque le contenu ou les paramètres d’une campagne changent, par exemple avec Mettre à jour une campagne, ou lorsqu’elle repasse à draft parce que vous avez annulé sa programmation ou l’avez désarchivée dans le tableau de bord. Lorsque le statut a changé, previous_status contient l’ancien statut.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.updated.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Statut actuel : draft, scheduled, queued, sending, sent, canceled ou archived.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

Statut avant le changement. Présent uniquement si le statut a changé.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.updated",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "scheduled"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "scheduled"
    }
  }
}

campaign.scheduled

Envoyé lorsque vous programmez une campagne en brouillon avec Envoyer ou programmer une campagne et un scheduled_at dans le futur, ou dans le tableau de bord. Consultez Tester et programmer.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.scheduled.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours scheduled.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

Statut avant le changement, généralement draft.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.scheduled",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "scheduled",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "scheduled",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.queued

Envoyé lorsque l’heure d’envoi d’une campagne programmée arrive et qu’Emailit la met en file d’attente. campaign.sending suit au début de l’envoi.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.queued.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours queued.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

Toujours scheduled.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.queued",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "queued",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "scheduled"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "queued",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "scheduled"
    }
  }
}

campaign.sending

Envoyé lorsqu’Emailit commence l’envoi d’une campagne : immédiatement lorsque vous l’envoyez avec Envoyer ou programmer une campagne ou depuis le tableau de bord, ou lorsqu’une campagne programmée mise en file d’attente démarre.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.sending.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours sending.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

draft lorsque vous avez envoyé la campagne immédiatement, queued pour une campagne programmée.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.sending",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "sending",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:00:03.214000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "sending",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:00:03.214000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.sent

Envoyé lorsqu’Emailit a créé et mis en file d’attente un e-mail pour chaque destinataire abonné de la campagne. Les événements de livraison, d’ouverture et de clic des e-mails individuels suivent au fur et à mesure. Consultez Rapports de campagne.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.sent.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours sent.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

Toujours sending.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.sent",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "sent",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:04:51.000000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "sending"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "sent",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:04:51.000000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "sending"
    }
  }
}

campaign.canceled

Envoyé lorsque vous annulez une campagne avec Annuler une campagne. Seules les campagnes draft et sending peuvent être annulées.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.canceled.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours canceled.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

draft ou sending.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.canceled",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "canceled",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "canceled",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.archived

Envoyé lorsque vous archivez une campagne envoyée dans le tableau de bord. La désarchiver la ramène au statut draft et déclenche campaign.updated avec previous_status défini sur archived.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.archived.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Toujours archived.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

previous_statusstring

Toujours sent.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.archived",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "archived",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:04:51.000000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "sent"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "archived",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:04:51.000000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "sent"
    }
  }
}

campaign.deleted

Envoyé lorsqu’une campagne est supprimée avec Supprimer une campagne ou dans le tableau de bord. Le payload correspond à la campagne telle qu’elle était avant sa suppression.

Les requêtes de webhook contiennent un tableau JSON d’événements comme celui-ci ; consultez Requêtes de webhook.

Champs

event_idstring

typestring

Toujours campaign.deleted.

objectobject

La campagne décrite par l’événement. Ses champs sont détaillés ci-dessous.

data.objectobject

Le même objet, sous la forme que l’API des événements renvoie dans data.

Objet campagne

idstring

ID de la campagne (cmp_…).

objectstring

Toujours campaign.

namestring

Nom de la campagne.

statusstring

Statut de la campagne au moment de sa suppression.

subjectstring

Ligne d’objet, ou une chaîne vide si elle n’est pas encore définie.

from_emailstring

Adresse de l’expéditeur, ou une chaîne vide.

from_namestring

Nom de l’expéditeur, ou une chaîne vide.

scheduled_atstring | null

Date d’envoi programmée de la campagne, ou null.

sent_atstring | null

Date d’envoi de la campagne, ou null.

created_atstring

Date de création de la campagne, au format ISO 8601 avec décalage UTC.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.deleted",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00"
    }
  }
}