Ir al contenido

Registrar URL de webhook

POST
/partner/webhooks
curl --request POST \
--url https://api.overtaker.online/api/v1/partner/webhooks \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "url": "example", "events": [ "example" ] }'

Para qué sirve. Configura la URL a la que Overtaker te notifica eventos en tiempo real (mensajes recibidos/enviados, leads creados, cambios de etapa, avisos de límite de uso).

Cuándo usarlo. Para integrar Overtaker con tu propio sistema/CRM y reaccionar a lo que pasa en los tenants de tus clientes.

Notas. La URL debe ser HTTPS. Overtaker firma cada evento (verifica la firma con tu webhook_secret).

Media type application/json
WebhookRegister
object
url
required
Url
string
events
required
Events
Array
Example generated
{
"url": "example",
"events": [
"example"
]
}

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}