WebHooks

Webhook es un mecanismo mediante el cual EngageLab envía de forma asíncrona los datos de los eventos de interés del cliente a la URL de devolución de llamada del cliente.

Se puede utilizar la API para consultar, añadir, actualizar y eliminar la URL de devolución de llamada.

Dirección de invocación

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, se debe verificar que el centro de datos seleccionado corresponda a la URL base adecuada.

POST/v1/webhooks

Consultar

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Encabezado

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
api_user	string	no	API_USER asociado
offset	int	no	Posición inicial, [0-], valor predeterminado: 0
limit	int	no	Cantidad, [0-100], valor predeterminado: 100

Ejemplo de solicitud:

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'

Este bloque de código se muestra en una ventana flotante

Ejemplo de valores devueltos:

{ "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
}

Este bloque de código se muestra en una ventana flotante

Añadir

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

POST

              
              POST

Este bloque de código se muestra en una ventana flotante

Encabezado

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
url	string	sí	Establecer esta propiedad en la URL a la que se desea que el Webhook de eventos envíe los datos de eventos.
api_user	string	no	API_USER asociado; valor predeterminado: todos los api_users
event	array	no	Tipos de eventos; p. ej., [1,3]. Valor predeterminado: todos los eventos.

Descripción de parámetros de eventos generales

Parámetro	Evento	Condición de activación
1	deliver	La entrega del correo electrónico se realizó correctamente
3	report_spam	El usuario reporta el correo electrónico
4	invalid_email	El mensaje no se envió correctamente
5	soft_bounce	El destinatario rechaza el mensaje
10	click	El usuario hace clic en el enlace
11	open	El usuario abre el correo
12	unsubscribe	El usuario se da de baja del correo electrónico
18	request	La solicitud de correo electrónico se realizó correctamente, incluidos los correos enviados y en envío.
32	sent	El correo electrónico se envió correctamente

Ejemplo de solicitud:

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'

Este bloque de código se muestra en una ventana flotante

Ejemplo de valores devueltos:

{ "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
            }
        ]
}

Este bloque de código se muestra en una ventana flotante

Modificar

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Encabezado

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
url	string	no	URL de devolución de llamada; si no se proporcionan parámetros, se omite la modificación.
api_user	string	no	API_USER asociado; si no se proporcionan parámetros, se omite la modificación.
event	array	no	Tipos de eventos; p. ej., [1,3]. Si no se proporcionan parámetros, se omite la modificación.

Ejemplo de solicitud:

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'

Este bloque de código se muestra en una ventana flotante

Ejemplo de valores devueltos:

{ "count":1 }

              
              {
   "count":1   
}

Este bloque de código se muestra en una ventana flotante

Eliminar

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

DELETE

              
              DELETE

Este bloque de código se muestra en una ventana flotante

Encabezado

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Ejemplo de solicitud

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'

Este bloque de código se muestra en una ventana flotante

Ejemplo de valores devueltos

{ "count":1 }

              
              {
    "count":1
}

Este bloque de código se muestra en una ventana flotante

API de WebHooks

Dirección de invocación

Consultar

Añadir

Modificar

Eliminar