PApartoo
Webhooks

Get a list of webhook configurations

Changed on

This endpoint returns the list of webhook configurations.

get/webhooks

Request

Query parameters

org_idinteger

Organization identifier, only required for PROVIDER users.

pageinteger

Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

per_pageinteger

Number of items to return per page. Currently limited to 100.

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "items": [
    {
      "id": 1,
      "url": "https://example.com/webhook",
      "event_type": "business_created",
      "created_at": "2024-11-27T16:10:44.929678Z",
      "updated_at": "2024-11-27T16:10:44.929678Z",
      "org_id": 1,
      "custom_headers": {
        "X-My-Header": "my-value",
        "X-Auth-Token": "secret-token"
      }
    }
  ]
}

Changes

  • dcb8190f5a29Revision changes
    • warning

      added the new email_opt_out_created enum value to the /// response property for the response status

    • warning

      added the new post_created enum value to the /// response property for the response status

    • warning

      added the new post_deleted enum value to the /// response property for the response status

    • warning

      added the new post_updated enum value to the /// response property for the response status

    • warning

      added the new post_validated enum value to the /// response property for the response status

    • warning

      added the new review_created enum value to the /// response property for the response status

    • warning

      added the new review_reply_created enum value to the /// response property for the response status

    • warning

      added the new review_reply_deleted enum value to the /// response property for the response status

    • warning

      added the new review_reply_updated enum value to the /// response property for the response status

    • warning

      added the new review_updated enum value to the /// response property for the response status

    • warning

      added the new scheduled_post_pushed enum value to the /// response property for the response status