PEpennylane
Webhooks

List webhook subscriptions

Changed on

Returns all webhook subscriptions for the authenticated token, paginated. Note that the secret is not included in the response.

get/api/external/v2/webhook_subscriptions

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/webhook_subscriptions
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token

Query parameters

cursorstring

Opaque cursor from a previous response to retrieve the next page

limitinteger

Number of items to return per page

Response

A paginated list of webhook subscriptions

has_moreboolean required

Indicates whether additional results are available

next_cursorstring nullable required

Cursor to retrieve the next set of results

Example response

{
  "items": [
    {
      "id": 12345,
      "callback_url": "https://example.com/webhooks",
      "events": [
        "dms_file.created",
        "customer_invoice.e_invoicing_status_updated",
        "supplier_invoice.e_invoicing_received"
      ],
      "enabled": true,
      "disabled_at": "2023-08-07T14:23:12.000Z",
      "last_failure_status": 500,
      "last_failure_at": "2023-08-07T14:23:12.000Z",
      "consecutive_failures": 3,
      "created_at": "2023-08-07T14:23:12.000Z",
      "updated_at": "2023-08-07T14:23:12.000Z"
    }
  ]
}

Changes

  • 871f863307e5Revision changes
    • warning

      added the new supplier_invoice.e_invoicing_received enum value to the /// response property for the response status

    • info

      api tag Webhooks added

    • info

      api tag Hidden removed