v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Webhooks/Webhook dispatches

Get webhook dispatch

Gets webhook dispatch object with all details.

get/v2/webhook-dispatches/{dispatchId}

Path parameters

dispatchIdstring required
Example:Zib4xbZsmvZeK55ua

Webhook dispatch ID.

Response

Example response

{
  "data": {
    "id": "asdLZtadYvn4mBZmm",
    "userId": "wRsJZtadYvn4mBZmm",
    "webhookId": "asdLZtadYvn4mBZmm",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "eventData": {
      "actorId": "vvE7iMKuMc5qTHHsR",
      "actorRunId": "JgwXN9BdwxGcu9MMF",
      "actorBuildId": "HG7ML7M8z78YcAPEB",
      "actorTaskId": "zRLp8SDOZz2NyLg7K"
    },
    "webhook": {
      "actionType": "HTTP_REQUEST",
      "condition": {
        "actorId": "hksJZtadYvn4mBuin",
        "actorTaskId": "asdLZtadYvn4mBZmm",
        "actorRunId": "hgdKZtadYvn4mBpoi"
      },
      "requestUrl": "https://example.com/webhook"
    },
    "calls": [
      {
        "startedAt": "2019-12-12T07:34:14.202Z",
        "finishedAt": "2019-12-12T07:34:14.202Z",
        "errorMessage": "Cannot send request",
        "responseStatus": 200,
        "responseBody": "{\"foo\": \"bar\"}"
      }
    ]
  }
}