Get list of webhook dispatches

GET 
/v2/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.

Request

Query Parameters

offset double
Number of records that should be skipped at the start. The default value is 0.

Example: 10
limit double
Maximum number of records to return. The default value as well as the maximum is 1000.

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

Example: true

Status 200

Response Headers

{
  "data": {
    "total": 2,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "count": 2,
    "items": [
      {
        "id": "asdLZtadYvn4mBZmm",
        "userId": "wRsJZtadYvn4mBZmm",
        "webhookId": "asdLZtadYvn4mBZmm",
        "createdAt": "2019-12-12T07:34:14.202Z",
        "status": "ACTIVE",
        "eventType": "ACTOR.BUILD.ABORTED",
        "eventData": "Unknown Type: object,null",
        "calls": [
          {
            "startedAt": "2019-12-12T07:34:14.202Z",
            "finishedAt": "2019-12-12T07:34:14.202Z",
            "errorMessage": "Cannot send request",
            "responseStatus": 200,
            "responseBody": "{\"foo\": \"bar\"}"
          }
        ]
      }
    ]
  }
}

Schema

• data object

  Common pagination fields for list responses.

  • total integer required

    The total number of items available across all pages.

    Possible values: >= 0

    
    Example: 2
  • offset integer required

    The starting position for this page of results.

    Possible values: >= 0

    
    Example: 0
  • limit integer required

    The maximum number of items returned per page.

    Possible values: >= 1

    
    Example: 1000
  • desc boolean required

    Whether the results are sorted in descending order.

    
    Example: false
  • count integer required

    The number of items returned in this response.

    Possible values: >= 0

    
    Example: 2
  • items object[] required

    • id string required
      Example: asdLZtadYvn4mBZmm
    • userId string required
      Example: wRsJZtadYvn4mBZmm
    • webhookId string required
      Example: asdLZtadYvn4mBZmm
    • createdAt string<date-time> required
      Example: 2019-12-12T07:34:14.202Z
    • status WebhookDispatchStatus (string) required

      Status of the webhook dispatch indicating whether the HTTP request was successful.

      Possible values: [ACTIVE, SUCCEEDED, FAILED]

    • eventType WebhookEventType (string) required

      Type of event that triggers the webhook.

      Possible values: [ACTOR.BUILD.ABORTED, ACTOR.BUILD.CREATED, ACTOR.BUILD.FAILED, ACTOR.BUILD.SUCCEEDED, ACTOR.BUILD.TIMED_OUT, ACTOR.RUN.ABORTED, ACTOR.RUN.CREATED, ACTOR.RUN.FAILED, ACTOR.RUN.RESURRECTED, ACTOR.RUN.SUCCEEDED, ACTOR.RUN.TIMED_OUT, TEST]

    • eventData eventData (object,null)

      • actorId string required
        Example: vvE7iMKuMc5qTHHsR
      • actorRunId string required
        Example: JgwXN9BdwxGcu9MMF
    • calls object[]

      • startedAt string,null<date-time> nullable
        Example: 2019-12-12T07:34:14.202Z
      • finishedAt string,null<date-time> nullable
        Example: 2019-12-12T07:34:14.202Z
      • errorMessage string | null nullable
        Example: Cannot send request
      • responseStatus integer | null nullable
        Example: 200
      • responseBody string | null nullable
        Example: {"foo": "bar"}

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)