List Webhooks

Returns a list of Webhooks belonging to your account.

Query Parameters

• start_cursor string

  The start cursor for Keyset pagination.

• per_page integer

  Possible values: >= 2 and <= 100

  Default value: 50

  The number of records per page to return.

• filter object

  The fields, operations, and values to filter the records by.

  • url object

    like string required
  • description object

    like string required
  • enabled object

    eq string required
  • created_by_id object

    eq string required
  • created_at object

    oneOf

    • MOD1
    • MOD2
    • MOD3
    • MOD4

    ---

    lt string required

    lte string required

    gt string required

    gte string required
  • updated_at object

    oneOf

    • MOD1
    • MOD2
    • MOD3
    • MOD4

    ---

    lt string required

    lte string required

    gt string required

    gte string required
• sort object

  The fields and direction to sort the results by.

  • id string

    Possible values: [asc, desc]

    Default value: desc

  • created_at string

    Possible values: [asc, desc]

  • updated_at string

    Possible values: [asc, desc]

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• start_cursor string

  The current start cursor of the records returned.

• next_cursor string

  The next cursor to retrieve the next page of records.

• per_page integer

  The maxumum number of records returned.

• estimated_remaining_count integer

  The number of remaining records including the returned records, up to a maximum of 500.

• filtered_by object[]

  The filters applied to the returned record set.

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4
  • MOD5
  • MOD6

  ---

  url object

  like string

  description object

  like string

  enabled object

  eq string

  created_by_id object

  eq string

  created_at object

  oneOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  lt string

  lte string

  gt string

  gte string

  updated_at object

  oneOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  lt string

  lte string

  gt string

  gte string
• sorted_by object[]

  The sorts applied to the returned record set.

  anyOf

  • MOD1
  • MOD2
  • MOD3

  ---

  updated_at string

  Possible values: [asc, desc]

  created_at string

  Possible values: [asc, desc]

  id string

  Possible values: [asc, desc]

• records object[]

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "url": {
        "like": "string"
      }
    },
    {
      "description": {
        "like": "string"
      }
    },
    {
      "enabled": {
        "eq": "string"
      }
    },
    {
      "created_by_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "account_id": 0,
      "all_events": true,
      "authorization": "string",
      "description": "string",
      "disabled_at": "2023-03-14T13:46:27-06:00",
      "disabled_reason": "string",
      "enabled": true,
      "failed_attempts": 0,
      "shared_key": "string",
      "subscribed_events": {},
      "url": "string"
    }
  ]
}

The format or parameters of the request was invalid

application/json

• Schema
• Example (from schema)

---

Schema

• errors object

  type

  items string

{
  "errors": {}
}

Request could not be authenticated

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Loading...