Skip to main content
POST
/
notifications
Criar Webhook
curl --request POST \
  --url 'https://sandbox.api.gohusky.net/notifications?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "ORDER_STATUS_UPDATED",
  "url": "https://www.seusite.com.br/url"
}
'
[
  {
    "id": "NTF-5e42e35a958f0",
    "event": "ORDER_STATUS_UPDATED",
    "url": "https://www.seusite.com.br/url"
  }
]

Authorizations

​
token
string
query
required

Token de autenticação via query parameter. Pode representar o ID público da operação (Operador Logístico) ou o ID público do embarcador (Restaurante, loja, farmácia).

Query Parameters

​
live_mode
boolean
required

Especifica o ambiente para executar a requisição.

Body

application/json
​
event
enum<string>
required

Tipo de evento para notificar por webhook

Available options:
ORDER_STATUS_UPDATED,
FLEET_QUEUE,
ORDER_CREATED,
ORDER_UPDATED,
ORDER_DRIVER_UPDATED,
DRIVER_CREATED,
DRIVER_UPDATED,
DRIVER_STATUS_UPDATED,
CLIENT_CREATED,
CLIENT_UPDATED,
CLIENT_STATUS_UPDATED,
all
Example:

"ORDER_STATUS_UPDATED"

​
url
string
required

URL para receber as notificações por webhook

Example:

"https://www.seusite.com.br/url"

Response

Notificação cadastrada com sucesso

​
id
string

ID da notificação

Example:

"NTF-5e42e35a958f0"

​
event
enum<string>

Tipo de evento cadastrado

Available options:
ORDER_STATUS_UPDATED,
FLEET_QUEUE,
ORDER_CREATED,
ORDER_UPDATED,
ORDER_DRIVER_UPDATED,
DRIVER_CREATED,
DRIVER_UPDATED,
DRIVER_STATUS_UPDATED,
CLIENT_CREATED,
CLIENT_UPDATED,
CLIENT_STATUS_UPDATED,
all
Example:

"ORDER_STATUS_UPDATED"

​
url
string

URL para receber as notificações

Example:

"https://www.seusite.com.br/url"