Skip to main content

Buscar Webhooks a partir do Evento

Descrição: Busca o webhook cadastrado a partir do evento

Endpoint

GET/api/v1/integration/webhooks/-/events/{webhook_event}

Regras

AtributoDescriçãoTipoObrigatórioValidações
webhook_eventEvento que irá gerar o disparo do gatilhostringSimValores 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
urlURI do cliente que deverá ser acionada quando o evento ocorrerstringSimEx: https://api.cliente.com/api/v1/receive (Deverá aceitar requisições do tipo POST.)
basic_authenticationSe preenchido, utilizaremos essa informação para passar no header via basic authstringNão

Exemplo de Requisição

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://homolog.api.merx.tech/api/v1/integration/webhooks/-/events/{webhook_event}"

Parâmetros

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationStringSim

Respostas

  • 200 - No Content
{
"id": "string",
"event": "string",
"url": "string",
"basic_authentication": "string",
"created_at": "string",
"updated_at": "string",

}
  • 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
  • 401 - Unauthorized

  • 404 - NotFound