v3

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

Get list of webhook dispatches

Gets the list of webhook dispatches that the user have.

The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000 records. By default, the records are sorted by the createdAt field in ascending order. To sort the records in descending order, use the desc=1 parameter.

get/v2/webhook-dispatches

Query parameters

offsetnumber double

Number of items that should be skipped at the start. The default value is 0.

limitnumber double
Example:1000

Maximum number of items to return. The default value as well as the maximum is 1000.

descboolean
Example:true

If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.

Response

Example response

{
  "data": {
    "total": 1,
    "limit": 1000,
    "count": 1,
    "items": [
      {
        "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\"}"
          }
        ]
      }
    ]
  }
}