Oznámení3 min čtení
Nové API endpointy: kontakty, události a webhooky
Spravujte kontakty, dotazujte se na události a konfigurujte webhooky programově s nejnovějšími rozšířeními Emailit API.
GAutor George
Právě jsme vydali tři nové skupiny zdrojů v Emailit API v2. Jsou to Kontakty, Události a Webhooky. Společně vám poskytují plnou programovou kontrolu nad vaším adresářem kontaktů, monitorování událostí a integrace webhooků.
Kontakty
API pro kontakty umožňuje vytvářet, číst, aktualizovat a mazat kontakty ve vašem pracovním prostoru. Každý kontakt obsahuje e-mailovou adresu, volitelné jméno a vlastní pole, a může být přihlášen k odběru jednoho nebo více okruhů příjemců jediným voláním.
Endpoint | Popis |
|---|---|
Stránkovaný seznam všech kontaktů | |
Načíst kontakt podle ID nebo e-mailu | |
Vytvořit nový kontakt a přihlásit k odběru | |
Aktualizovat jméno, e-mail, vlastní pole nebo stav odhlášení | |
Smazat kontakt a všechny související odběratele |
Kontakty lze vyhledávat podle jejich ID (con_xxx) nebo podle e-mailové adresy, takže můžete použít jakýkoli identifikátor, který je pro vás nejpohodlnější.
{
"email": "jan@priklad.cz",
"first_name": "Jan",
"last_name": "Novák",
"custom_fields": { "company": "Acme s.r.o." },
"audiences": ["aud_2BxFg7KNqr5M..."]
}Události
Události se vytvářejí automaticky, kdykoli se ve vašem pracovním prostoru něco stane. Například je doručen e-mail, vytvoří se kontakt, aktualizuje se doména a tak dále. API pro události vám poskytuje přístup pouze pro čtení k tomuto toku aktivit.
Endpoint | Popis |
|---|---|
Stránkovaný seznam s filtrováním podle typu a volitelným datovým obsahem | |
Načíst jednu událost s kompletními daty |
Můžete filtrovat podle jednoho nebo více typů událostí pomocí hodnot oddělených čárkami a přepnout include_data pro kontrolu, zda se v odpovědích seznamu vrací kompletní obsah.
GET /v2/events?type=email.accepted,email.delivered&include_data=trueWebhooky
Webhooky vám umožňují přijímat HTTP zpětná volání v reálném čase, kdykoli dojde k událostem. Nové API pro webhooky vám poskytuje úplnou kontrolu. Můžete vytvářet, aktualizovat, povolovat/zakazovat a mazat webhook endpointy, vše prostřednictvím API.
Endpoint | Popis |
|---|---|
Stránkovaný seznam všech webhooků | |
Načíst webhook podle ID | |
Vytvořit nový webhook endpoint | |
Aktualizovat URL, události nebo stav povolení | |
Smazat webhook podle ID nebo názvu |
Můžete se přihlásit k odběru konkrétních typů událostí nebo použít all_events pro příjem všeho.
{
"name": "Produkční webhook",
"url": "https://priklad.cz/webhook",
"events": ["email.accepted", "email.delivered", "email.bounced"]
}K dispozici je více než 30 typů událostí napříč e-maily, doménami, okruhy příjemců, odběrateli, kontakty, šablonami, potlačeními a ověřováním e-mailů. Kompletní seznam najdete v dokumentaci Vytvořit webhook.
Začínáme
Všechna tři API vyžadují API klíč s plnými oprávněními. Přejděte do Reference API a prozkoumejte všechny nové endpointy, nebo se rovnou ponořte do dokumentace odkazované výše.
