notifications

List notifications front-door

List webhook notifications for a team, paginated, with optional filters

get/team/{team_id}/notifications

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/team/{team_id}/notifications
Auth: HTTP bearer

Path parameters

team_idstring required

Team ID

Example:Recusandae perspiciatis.

Query parameters

webhook_idstring required

Filter by webhook ID

Example:webhook-123

status'all' | 'success' | 'failure'

Filter for unacknowledged notifications only

Example:all

typesstring[]

Filter by notification types, e.g., 'energy.invoices.sync.completed'

[
  "energy.balances.sync.completed",
  "energy.invoices.sync.completed"
]

end_user_idstring

Filter by end user ID

Example:eu_2yRHN2ag2y4p8kCtm5DOeccZEXB

cursorstring

Cursor for pagination

Example:cursor-123

page_sizeinteger

The number of items per page

Example:25

Response

OK response.

cursorstring required

Cursor for pagination

page_sizeinteger required

Number of items per page

Example response

{
  "cursor": "Adipisci voluptate qui amet molestiae vel.",
  "notifications": [
    {
      "acknowledged": false,
      "arrangement_id": "arrangement-456",
      "delivery_attempt": 3,
      "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
      "error": "Failed to send notification",
      "id": "a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4",
      "request": "{\"key\": \"value\"}",
      "response": "{\"status\": \"success\"}",
      "sent_at": "2025-05-01T14:00:00Z",
      "status": 200,
      "team_id": "team-123",
      "type": "energy.invoices.sync.completed",
      "webhook_id": "webhook-123"
    },
    {
      "acknowledged": false,
      "arrangement_id": "arrangement-456",
      "delivery_attempt": 3,
      "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
      "error": "Failed to send notification",
      "id": "a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4",
      "request": "{\"key\": \"value\"}",
      "response": "{\"status\": \"success\"}",
      "sent_at": "2025-05-01T14:00:00Z",
      "status": 200,
      "team_id": "team-123",
      "type": "energy.invoices.sync.completed",
      "webhook_id": "webhook-123"
    }
  ],
  "page_size": 3762779735735815700
}

Changes

No recorded changes to this operation across all 1 revision of this API.