- Primeros pasos
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Solicitudes de Webhooks
http://documentation.azurewebsites.net/webhook/documentation
.
Obtener
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks?$filter=Url eq 'http://documentation.azurewebsites.net/webhook/documentation'
Solicitar encabezados.
Clave |
Valor |
---|---|
Autorización |
Portador |
Código de respuesta
200 OK
Cuerpo de respuesta
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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"
}
]
}]
}
Id
.
Obtener
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks(10)
Solicitar encabezados.
Clave |
Valor |
---|---|
Autorización |
Portador |
Código de respuesta
200 OK
Cuerpo de respuesta
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com",
"Enabled": false,
"Secret": "1234567890",
"SubscribeToAllEvents": true,
"AllowInsecureSsl": false,
"Id": 10,
"Events": []
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com",
"Enabled": false,
"Secret": "1234567890",
"SubscribeToAllEvents": true,
"AllowInsecureSsl": false,
"Id": 10,
"Events": []
}
El siguiente ejemplo te permite recuperar todos los tipos de eventos a los que uno puede suscribirse en Orchestrator.
Obtener
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes()
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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"
}
]
}
Url
, Enabled
, Secret
, AllowInsecureSsl
y el Events
al que está suscrito el webhook con el 10 Id
.
PONER
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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"
}
]
}
ping
, su ID, TenantId
, OrganizationUnitId
y UserId
.
Publicar
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks(11)/UiPath.Server.Configuration.OData.Ping
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
"Type": "ping",
"EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
"Timestamp": "2018-11-19T14:32:47.6024779Z",
"TenantId": 57,
"OrganizationUnitId": null,
"UserId": 583
}
- Recuperación de webhooks
- Según su URL
- Por su ID
- Recuperar todos los tipos de eventos disponibles
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Editar un Webhook
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta
- Cuerpo de respuesta
- Prueba de la URL de destino de Webhook
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta