WebhookList

  • currentPage
    Type: integer

    Current page number

  • totalCount
    Type: integer

    Total number of webhooks matching the query

  • totalPages
    Type: integer

    Total number of pages

  • webhooks
    Type: array object[] ยท Webhook[]
    • active
      Type: boolean
      required

      Whether the webhook is active

    • events
      Type: array string[]
      required

      List of events the webhook is subscribed to

    • id
      Type: integer
      read-only
      required

      Integer numbers.

    • name
      Type: string
      required

      Name of the webhook

    • url
      Type: string
      required

      URL where webhook events will be sent

    • createdAt
      Type: stringFormat: date-time
      read-only

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • createdBy
      Type: string
      read-only
    • description
      Type: string

      Description of the webhook

    • headers
      Type: object

      Custom headers to send with the webhook request

    • updatedAt
      Type: stringFormat: date-time
      read-only

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • updatedBy
      Type: string
      read-only