List of Webhooks | Developer portal

Get list of Webhooks

Retrieve a list of webhooks, optionally filtering by various parameters such as eshop, event and more.

Request structure

Endpoint:	POST /api/eshop-webhook/list
URL (prod):	https://app.mailship.eu/api/eshop-webhook/list
Headers:	`Authorization: Bearer YOUR_ACCESS_TOKEN Accept: application/json`
Request body	Request body supports multiple filtering options. Please see the API Doc for more details.

Request Examples (cURL):

Get all webhooks (no filters):

curl --location --request POST 'https://app.mailship.eu/api/eshop-webhook/list' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

This request retrieves a list of e-shop webhooks where the eshop.name is "internal.mailstep". The results are sorted by creation date (createdAt) and only include the following fields: id, eshop, event, destination, active, authentication, and changedAt.

curl --location 'https://app.mailship.eu/api/eshop-webhook/list' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
  "criteria": {
    "eshop.name": {
      "eq": "internal.mailstep"
    }
  },
  "sort": [
    {
      "field": "createdAt"
    }
  ],
  "select": [
    "id",
    "eshop",
    "event",
    "destination",
    "active",
    "authentication",
    "changedAt"
  ]
}'

Response

If successful, returns a paginated list of webhooks in JSON format based on searched criteria.

No request body: Returns all webhooks.
With filters in request body:
- criteria: Returns only matching webhooks.
- select: Only the requested fields are returned.

See more details in the API Doc.