WebHooks

Le webhook est un mécanisme permettant à EngageLab de pousser de manière asynchrone les données relatives aux événements suivis par les clients vers l'URL de rappel du client.

Vous pouvez utiliser l'API pour interroger, ajouter, mettre à jour et supprimer une URL de rappel.

Adresse d'appel

Centre de données	URL
Singapour	https://email.api.engagelab.cc
Turquie	https://emailapi-tr.engagelab.com

Lorsque vous utilisez l'API REST, assurez-vous que le centre de données sélectionné correspond à la base URL appropriée.

POST/v1/webhooks

Interroger

URL

https://email.api.engagelab.cc/v1/webhooks

              
              https://email.api.engagelab.cc/v1/webhooks

Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP de la requête

GET

GET

Afficher ce bloc de code dans la fenêtre flottante

En-tête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Description des paramètres de requête

paramètre	type	obligatoire ou non	description
api_user	string	non	API_USER associé
offset	int	non	position de départ, [0-], par défaut 0
limit	int	non	quantité, [0-100], par défaut 100

Exemple de requête :

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/webhooks?api_user=abcd&offset=0&limit=1'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/webhooks?api_user=abcd&offset=0&limit=1'

Afficher ce bloc de code dans la fenêtre flottante

Exemple de valeur retournée :

{ "result": [ { "url": "http://qxxx.com", "event": [1,3], "api_user": "my_test", "id":168 } ], "count":1, "total":2 }

              
              {
    "result": [
              {
                "url": "http://qxxx.com",
                "event": [1,3],
                "api_user": "my_test",
                "id":168
            }
        ], 
        "count":1,
        "total":2
}

Afficher ce bloc de code dans la fenêtre flottante

Ajouter

URL

https://email.api.engagelab.cc/v1/webhooks

              
              https://email.api.engagelab.cc/v1/webhooks

Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP de la requête

POST

              
              POST

Afficher ce bloc de code dans la fenêtre flottante

En-tête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Description des paramètres du corps

paramètre	type	obligatoire ou non	description
url	string	oui	Définissez cette propriété sur l'URL à laquelle vous souhaitez que le Webhook d'événement envoie les données d'événement.
api_user	string	non	API_USER associé requis, par défaut tous les api_users
event	array	non	Types d'événements. ex : [1,3]. Par défaut tous les événements.

Description des paramètres des événements généraux

paramètre	événement	Condition de déclenchement
1	deliver	L'e-mail a été délivré avec succès
3	report_spam	L'utilisateur signale l'e-mail comme spam
4	invalid_email	Le message n'a pas été envoyé avec succès
5	soft_bounce	Le destinataire rejette le message
10	click	L'utilisateur clique sur un lien
11	open	L'utilisateur ouvre l'e-mail
12	unsubscribe	L'utilisateur se désabonne de l'e-mail
18	request	La demande d'e-mail a réussi, y compris les e-mails envoyés et en cours d'envoi.
32	sent	L'e-mail a été envoyé avec succès

Exemple de requête :

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"url": "123456","api_user":"qq.com", "event":[1,3]}' 'https://email.api.engagelab.cc/v1/webhooks'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"url": "123456","api_user":"qq.com", "event":[1,3]}'
     'https://email.api.engagelab.cc/v1/webhooks'

Afficher ce bloc de code dans la fenêtre flottante

Exemple de valeur retournée :

{ "result": [ { "url": "http://qxxx.com", "event": [1,3], "api_user": "my_test", "id":167 } ] }

              
              {
    "result": [
              {
                "url": "http://qxxx.com",
                "event": [1,3],
                "api_user": "my_test",
                "id":167
            }
        ]
}

Afficher ce bloc de code dans la fenêtre flottante

Modifier

URL

https://email.api.engagelab.cc/v1/webhooks/{id}

              
              https://email.api.engagelab.cc/v1/webhooks/{id}

Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP de la requête

PUT

PUT

Afficher ce bloc de code dans la fenêtre flottante

En-tête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Description des paramètres du corps

paramètre	type	obligatoire ou non	description
url	string	non	URL de rappel, si aucun paramètre n'est fourni, ignorer la modification.
api_user	string	non	API_USER associé, si aucun paramètre n'est fourni, ignorer la modification.
event	array	non	Types d'événements. ex : [1,3]. Si aucun paramètre n'est fourni, ignorer la modification.

Exemple de requête :

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"url": "http://example2.com"}' 'https://email.api.engagelab.cc/v1/webhooks/1111111'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"url": "http://example2.com"}'
     'https://email.api.engagelab.cc/v1/webhooks/1111111'

Afficher ce bloc de code dans la fenêtre flottante

Exemple de valeur retournée :

{ "count":1 }

              
              {
   "count":1   
}

Afficher ce bloc de code dans la fenêtre flottante

Supprimer

URL

https://email.api.engagelab.cc/v1/webhooks/{id}

              
              https://email.api.engagelab.cc/v1/webhooks/{id}

Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP de la requête

DELETE

              
              DELETE

Afficher ce bloc de code dans la fenêtre flottante

En-tête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Exemple de requête

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/webhooks/1111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/webhooks/1111111'

Afficher ce bloc de code dans la fenêtre flottante

Exemple de valeur retournée

{ "count":1 }

              
              {
    "count":1
}

Afficher ce bloc de code dans la fenêtre flottante

API WebHooks

Adresse d'appel

Interroger

Ajouter

Modifier

Supprimer