Atualizar Webhook
Descrição: Atualiza um gatilho a partir de determinado evento
Endpoint
PUT/api/v1/integration/webhooks
Regras
Atributo | Descrição | Tipo | Obrigatório | Validações |
---|---|---|---|---|
webhook_event | Evento que irá gerar o disparo do gatilho | string | Sim | Valores válidos: CREATE_PRODUCER , UPDATE_PRODUCER , DELETE_PRODUCER , CREATE_WAREHOUSE , UPDATE_WAREHOUSE , DELETE_WAREHOUSE , CREATE_FARM , UPDATE_FARM , DELETE_FARM , CREATE_GUEST_USER , UPDATE_GUEST_USER , DELETE_GUEST_USER , CREATE_DELIVERY_PLACE , UPDATE_DELIVERY_PLACE , DELETE_DELIVERY_PLACE , CREATE_ORDER_COMMITMENT , UPDATE_ORDER_COMMITMENT , DELETE_ORDER_COMMITMENT , CREATE_WALLET , UPDATE_WALLET , DELETE_WALLET , UPDATE_WORKFLOW_ORDER_COMMITMENT , CHANGE_PRODUCER_STATUS_ESG , CHANGE_FARM_STATUS_ESG , PRODUCER_PRODUCTION |
url | URI do cliente que deverá ser acionada quando o evento ocorrer | string | Sim | Ex: https://api.cliente.com/api/v1/receive (Deverá aceitar requisições do tipo POST.) |
basic_authentication | Se preenchido, utilizaremos essa informação para passar no header via basic auth | string | Não |
Exemplo de Requisição
curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
-d '{
"webhook_event": "CREATE_FARM",
"url": "https://api.cliente.com/api/v1/receive",
"basic_authentication": "usuario:senha"
}' \
"https://homolog.api.merx.tech/api/v1/integration/webhooks"
Parâmetros
Parâmetros de Cabeçalho
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
Authorization | String | Sim |
Parâmetros do Corpo
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
... (todos os atributos listados nas regras) |
Respostas
204 - No Content
400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
401 - Unauthorized
404 - NotFound