MailerGetWebhooks¶

GET mailer/webhooks/list

Returns the webhooks of the brand with their public paths, so the configuration in the provider dashboard can be compared against what the module actually expects.

Access Control¶

Allowed role: admin, within the brand of the caller.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/webhooks/list?limit=50&orderBy=%5B%22id%22%2C%22DESC%22%5D
Authorization: <JWT_TOKEN>

{
  "command": "MailerGetWebhooks",
  "extID": "1",
  "data": {
    "limit": 50,
    "orderBy": [
      "id",
      "DESC"
    ]
  }
}

const res = await platform.MailerGetWebhooks({
  limit: 50,
  orderBy: [
    "id",
    "DESC"
  ]
});

Request Data¶

Field	Type	Required	Description
`limit`	int	No	Page size, `1..1000`, default `100`
`offset`	int	No	Rows to skip
`orderBy`	array	No	Sorting, for example `["id", "DESC"]`
`count`	array	No	Row count aggregate, `["id"]`
`where`	object	No	Filters, see Table filter syntax

Response Data¶

{
  "rows": [
    {
      "id": 2,
      "brand": "default",
      "profileId": 3,
      "uuid": "9f2a1c7d4b6e",
      "name": "Postmark events",
      "events": [],
      "status": "ENABLED",
      "path": "/mailer/handleWebhooks/9f2a1c7d4b6e",
      "createdAt": "2026-08-24 13:55:20"
    }
  ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Not an admin session