Webhook の要求

Webhook を取得する

URL に基づいて取得する

以下の例では、情報を URL http://documentation.azurewebsites.net/webhook/documentation に送信するすべての Webhook を取得できます。

GET

/odata/Webhooks?$filter=Url eq 'http://documentation.azurewebsites.net/webhook/documentation'

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "/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 に基づいて取得する

以下の要求では、特定の Webhook に関する情報を、その Id に従って取得できます。

GET

/odata/Webhooks(10)

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "/odata/$metadata#Webhooks/$entity",
  "Url": "https://orchestrator.uipath.com",
  "Enabled": false,
  "Secret": "1234567890",
  "SubscribeToAllEvents": true,
  "AllowInsecureSsl": false,
  "Id": 10,
  "Events": []
}

利用可能なすべてのイベントの種類を取得する

以下の例では、Orchestrator でサブスクライブできるイベントの種類をすべて取得できます。

GET

/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes()

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "/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"
        }
    ]
}

Webhook を編集する

次の例では、Url、Enabled ステータス、Secret、AllowInsecureSsl、および　Id として 10 を持つ Webhook がサブスクライブされる Events を変更します。

PUT

/odata/Webhooks(10)

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

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

応答コード

200 OK

応答本文

{
    "@odata.context": "/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"
        }
    ]
}

Webhook のターゲット URL をテストする

次のリクエストでは、ターゲット URL をテストします。種類が ping のイベント、その TenantId、OrganizationUnitId、UserId が返されます。

POST

/odata/Webhooks(11)/UiPath.Server.Configuration.OData.Ping

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
  "Type": "ping",
  "EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
  "Timestamp": "2018-11-19T14:32:47.6024779Z",
  "TenantId": 57,
  "OrganizationUnitId": null,
  "UserId": 583
}