Requêtes relatives aux Webhooks

Récupération des Webhooks

En fonction de l'URL

L'exemple suivant permet de récupérer tous les Webhooks qui envoient des informations à l'URL http://documentation.azurewebsites.net/webhook/documentation.

Obtenir

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks?$filter=Url eq 'http://documentation.azurewebsites.net/webhook/documentation'

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@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"
            }
        ]
    }]
}

En fonction de l'ID

La requête suivante permet de récupérer les informations sur un Webhook spécifique, en fonction de son Id.

Obtenir

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks(10)

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
  "@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": []
}

Récupération de tous les types d'événements disponibles

L'exemple ci-dessous permet de récupérer tous les types d'événements auxquels il est possible de s'abonner dans Orchestrator.

Obtenir

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes()

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@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"
        }
    ]
}

Modification d'un Webhook

L'exemple ci-dessous modifie l'état de Url, de Enabled, Secret, AllowInsecureSsl et le Webhook Events avec le 10 comme Id auquel il est abonné.

METTRE

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks(10)

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
    "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"
        }
    ]
}

Codes de réponse

200 OK

Corps de la réponse

{
    "@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"
        }
    ]
}

Test de l'URL cible du Webhook

La requête suivante permet de tester l'URL cible, et en cas de réussite, elle renvoie un type d'événement ping, son ID TenantId, OrganizationUnitId et UserId.

Publier

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Webhooks(11)/UiPath.Server.Configuration.OData.Ping

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
  "@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
}