Pular para o conteúdo principal

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

Exemplo de Requisição

curl -X GET \
-H "Authorization: {SUA_API_KEY}" \
"https://api.merx.tech/api/v1/integration/webhooks/-/events/CREATE_FARM"

Parâmetros

Parâmetros de Caminho:

NomeDescriçãoTipoObrigatório
webhook_eventEvento pelo qual o webhook foi cadastradoStringSim

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationChave de API obtida via support-api@merx.techStringSim

Respostas

  • 200 - Ok
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event": "CREATE_FARM",
"url": "https://api.cliente.com/api/v1/receive",
"basic_authentication": "string",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
  • 400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
  • 401 - Unauthorized

  • 404 - NotFound