orchestrator
2023.10
true
- Introdução
- Autenticação
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
- APIs de gestão de plataforma
Solicitações de webhooks
Guia da API do Orchestrator
Last updated 17 de jun de 2024
Solicitações de webhooks
O exemplo a seguir permite obter todos os webhooks que enviam informações para a URL
http://documentation.azurewebsites.net/webhook/documentation
.
Obter
https://{yourDomain}/odata/Webhooks?$filter=Url eq 'http://documentation.azurewebsites.net/webhook/documentation'
Cabeçalhos de solicitação.
Chave |
Valor |
---|---|
Autorização |
O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Webhooks",
"@odata.count": 1,
"value": [{
"Url": "http://documentation.azurewebsites.net/webhook/documentation",
"Enabled": true,
"Secret": "1234567890",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": false,
"Id": 4,
"Events": [{
"EventType": "job.started"
},
{
"EventType": "process.created"
},
{
"EventType": "process.deleted"
},
{
"EventType": "process.updated"
},
{
"EventType": "queue.created"
}
]
}]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Webhooks",
"@odata.count": 1,
"value": [{
"Url": "http://documentation.azurewebsites.net/webhook/documentation",
"Enabled": true,
"Secret": "1234567890",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": false,
"Id": 4,
"Events": [{
"EventType": "job.started"
},
{
"EventType": "process.created"
},
{
"EventType": "process.deleted"
},
{
"EventType": "process.updated"
},
{
"EventType": "queue.created"
}
]
}]
}
A solicitação a seguir permite que você recupere informações sobre um webhook específico, de acordo com seu
Id
.
Obter
https://{yourDomain}/odata/Webhooks(10)
Cabeçalhos de solicitação.
Chave |
Valor |
---|---|
Autorização |
O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com",
"Enabled": false,
"Secret": "1234567890",
"SubscribeToAllEvents": true,
"AllowInsecureSsl": false,
"Id": 10,
"Events": []
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com",
"Enabled": false,
"Secret": "1234567890",
"SubscribeToAllEvents": true,
"AllowInsecureSsl": false,
"Id": 10,
"Events": []
}
O exemplo abaixo permite que você recupere todos os tipos de eventos que podem ser assinados no Orchestrator.
Obter
https://{yourDomain}/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes()
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Application.Dto.Webhooks.WebhookEventTypeDto)",
"value": [
{
"Name": "process.created",
"Group": "process"
},
{
"Name": "process.updated",
"Group": "process"
},
{
"Name": "process.deleted",
"Group": "process"
},
{
"Name": "schedule.failed",
"Group": "schedule"
},
{
"Name": "robot.status",
"Group": "robot"
},
{
"Name": "job.started",
"Group": "job"
},
{
"Name": "job.completed",
"Group": "job"
},
{
"Name": "job.faulted",
"Group": "job"
},
{
"Name": "job.stopped",
"Group": "job"
},
{
"Name": "job.created",
"Group": "job"
},
{
"Name": "queue.created",
"Group": "queue"
},
{
"Name": "queue.updated",
"Group": "queue"
},
{
"Name": "queue.deleted",
"Group": "queue"
},
{
"Name": "queueItem.added",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionStarted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionFailed",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionCompleted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionAbandoned",
"Group": "queueItem"
},
{
"Name": "robot.created",
"Group": "robot"
},
{
"Name": "robot.updated",
"Group": "robot"
},
{
"Name": "robot.deleted",
"Group": "robot"
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Application.Dto.Webhooks.WebhookEventTypeDto)",
"value": [
{
"Name": "process.created",
"Group": "process"
},
{
"Name": "process.updated",
"Group": "process"
},
{
"Name": "process.deleted",
"Group": "process"
},
{
"Name": "schedule.failed",
"Group": "schedule"
},
{
"Name": "robot.status",
"Group": "robot"
},
{
"Name": "job.started",
"Group": "job"
},
{
"Name": "job.completed",
"Group": "job"
},
{
"Name": "job.faulted",
"Group": "job"
},
{
"Name": "job.stopped",
"Group": "job"
},
{
"Name": "job.created",
"Group": "job"
},
{
"Name": "queue.created",
"Group": "queue"
},
{
"Name": "queue.updated",
"Group": "queue"
},
{
"Name": "queue.deleted",
"Group": "queue"
},
{
"Name": "queueItem.added",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionStarted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionFailed",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionCompleted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionAbandoned",
"Group": "queueItem"
},
{
"Name": "robot.created",
"Group": "robot"
},
{
"Name": "robot.updated",
"Group": "robot"
},
{
"Name": "robot.deleted",
"Group": "robot"
}
]
}
O exemplo abaixo altera o estado
Url
, Enabled
, Secret
, AllowInsecureSsl
e o Events
ao qual o webhook com 10 Id
está inscrito.
COLOCAR
https://{yourDomain}/odata/Webhooks(10)
{
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"AllowInsecureSsl": true,
"Events": [{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
{
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"AllowInsecureSsl": true,
"Events": [{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": true,
"Id": 10,
"Events": [
{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": true,
"Id": 10,
"Events": [
{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
A solicitação a seguir permite que você teste o URL de destino e, se for bem-sucedido, retornará um tipo de evento
ping
, seu Id, TenantId
, OrganizationUnitId
e UserId
.
Postar
https://{yourDomain}/odata/Webhooks(11)/UiPath.Server.Configuration.OData.Ping
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
"Type": "ping",
"EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
"Timestamp": "2018-11-19T14:32:47.6024779Z",
"TenantId": 57,
"OrganizationUnitId": null,
"UserId": 583
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
"Type": "ping",
"EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
"Timestamp": "2018-11-19T14:32:47.6024779Z",
"TenantId": 57,
"OrganizationUnitId": null,
"UserId": 583
}
- Recuperando webhooks
- De acordo com a URL deles
- De acordo com um Id
- Recuperando todos os tipos de eventos disponíveis
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Edição de um webhook
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta
- Testando o URL de destino do webhook
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta