Listar webhooks de engajamento
curl --request GET \
--url https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'{
"success": true,
"data": {
"webhooks": [
{
"id": 1,
"headers": {
"X-Cliente-Nome": "nome-exemplo",
"X-Cliente-Chave": "chave-exemplo"
},
"url": "https://www.exemplo.url",
"bandeiras": [
{
"id": 1,
"nome": "Bandeira Exemplo 1",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 2,
"nome": "Bandeira Exemplo 2",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 3,
"nome": "Bandeira Exemplo 3",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
},
{
"id": 2,
"headers": null,
"url": "https://www.exemplo.url2",
"bandeiras": [
{
"id": 6,
"nome": "Bandeira Exemplo 6",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
}
],
"bandeiras_sem_webhook": [
{
"id": 4,
"nome": "Bandeira Exemplo 4"
},
{
"id": 5,
"nome": "Bandeira Exemplo 5"
}
]
}
}Engajamento
Listar webhooks de engajamento
Lista os webhooks de engajamento cadastrados e as bandeiras sem webhook vinculado. Apenas bandeiras do mesmo grupo são consideradas, e somente bandeiras ativas são retornadas na lista de bandeiras sem webhook vinculado.
GET
/
integracao
/
v1
/
engajamento
/
index
Listar webhooks de engajamento
curl --request GET \
--url https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'{
"success": true,
"data": {
"webhooks": [
{
"id": 1,
"headers": {
"X-Cliente-Nome": "nome-exemplo",
"X-Cliente-Chave": "chave-exemplo"
},
"url": "https://www.exemplo.url",
"bandeiras": [
{
"id": 1,
"nome": "Bandeira Exemplo 1",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 2,
"nome": "Bandeira Exemplo 2",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 3,
"nome": "Bandeira Exemplo 3",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
},
{
"id": 2,
"headers": null,
"url": "https://www.exemplo.url2",
"bandeiras": [
{
"id": 6,
"nome": "Bandeira Exemplo 6",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
}
],
"bandeiras_sem_webhook": [
{
"id": 4,
"nome": "Bandeira Exemplo 4"
},
{
"id": 5,
"nome": "Bandeira Exemplo 5"
}
]
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Obrigatório. Sua chave API.
Response
200 - application/json
Sucesso
The response is of type object.
⌘I
