Logo PopinaPopina API

Get webhooks list

Get a list of webhooks based on provided filters and pagination parameters. Each webhook is linked to a specific location and recipient, registering an endpoint URL for an event (e.g., order.paid).

GET/v1/webhooks/
authorization<token>

To get an API key, please contact us. We'll be happy to help you.

In: header

Query Parameters

index?integer

Index of the page query parameter

Default0
Range0 <= value
size?integer

Number of record on a page query parameter (capped to 100)

Default10
Range1 <= value <= 100

Response Body

application/json

curl -X GET "http://localhost:4007/v1/webhooks/"
{
  "data": [
    {
      "id": "5f99d799-73d4-43e0-b247-65918dcdb85f",
      "createdAt": "2021-08-02T16:52:15.000Z",
      "updatedAt": "2021-08-02T16:52:15.000Z",
      "events": [
        "order.paid"
      ],
      "endpointUrl": "https://example.com",
      "locationId": "5f99d799-73d4-43e0-b247-65918dcdb85f",
      "recipientId": "5f99d799-73d4-43e0-b247-65918dcdb85f"
    }
  ],
  "meta": {
    "totalPage": 1,
    "totalCount": 2,
    "currentPageIndex": 0,
    "pageSize": 20
  },
  "links": {
    "self": "https://url?page=0&pageSize=20",
    "first": "https://url?page=0&pageSize=20",
    "last": "https://url?page=0&pageSize=20",
    "prev": null,
    "next": null
  }
}