DocumentazioneCreare endpoint webhook

Creare endpoint webhook

Registrare POST /webhooks/endpoints con scope webhooks:manage.

Registra un URL HTTPS pubblico per ricevere consegne firmate da MailingCore. Scope richiesto: webhooks:manage.

Creare endpoint

POST /webhooks/endpoints
Authorization: Bearer mc_live_xxxx
X-Tenant-Id: clxxxxxxxx
Content-Type: application/json
{
  "url": "https://tuo-saas.com/webhooks/mailingcore",
  "events": [
    "contact.unsubscribed",
    "email.bounced",
    "email.complained"
  ],
  "secret": "whsec_tuo_segreto_condiviso_min_32_chars"
}
CampoRegole
urlEndpoint HTTPS pubblico sul tuo server
eventsSottoinsieme dei tipi supportati — vedi Catalogo eventi
secretChiave HMAC condivisa; salvala nelle variabili d'ambiente. Verifica X-MailingCore-Signature

Risposta (201 Created) include l'id dell'endpoint e il secret (salvalo subito — non viene mostrato di nuovo per intero).

  1. Provisionare API key

    Crea una key con webhooks:manage (più altri scope necessari all'integrazione). Vedi API key e scope.

  2. Implementare il receiver

    Accetta POST, leggi il raw body, verifica firma HMAC, rispondi 200 rapidamente.

  3. Registrare l'endpoint

    Chiama POST /webhooks/endpoints con l'URL di produzione e l'elenco minimo di eventi.

  4. Inviare evento di test

    Attiva un invio o una disiscrizione in staging e conferma la consegna nel Log consegne.

Esempio: eventi per integratore B2B

Un SaaS che sincronizza contatti e lancia campagne di solito si iscrive a:

EventoMotivo
contact.unsubscribedRevocare il consenso newsletter nell'app dopo disiscrizione ospitata
email.bounced (hard)Segnare indirizzi non validi e bloccare invii futuri
email.complainedRevocare consenso e avvisare gli operatori

Opzionale: email.delivered, email.opened, email.clicked per metriche di engagement.

Gestire endpoint

AzioneEndpoint
ElencaGET /webhooks/endpoints
Disabilita / abilitaPATCH /webhooks/endpoints/:id/toggle
Log consegneGET /webhooks/endpoints/:id/deliveries?limit=20
EliminaDELETE /webhooks/endpoints/:id

Correlati