> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/notification.md).
# Notification
A **notification** is one outbound or inbound delivery — an email that leaves the system because something happened on a ticket, or a message that arrived. They are created by the system, never by a client; these endpoints exist to see what happened and to push a failed delivery back into the queue.
| Status | Meaning |
| ------------ | --------------------------------------------------------- |
| `PENDING` | waiting for its next attempt |
| `DELIVERING` | being handed to the transport right now |
| `DELIVERED` | done |
| `DEAD` | given up on after repeated failures; `lastError` says why |
## List notifications
> Returns the caller's own notification feed — one entry per notification that was addressed to them,\
> newest last unless \`sort\` says otherwise. Entries of other users are never returned, whatever the\
> filter says.\
> \
> \*\*Filterable\*\* — \`id\`, \`userId\`, \`notificationId\`, \`readAt\`.\
> \
> \*\*Sortable\*\* — \`id\`, \`createdAt\`.\
> \
> \*\*Searchable\*\* — nothing yet.\
> \
> \`readAt\` is when the caller marked the entry as read and is empty while it is unread — unread entries\
> are \`{"field":"readAt","op":"isNull"}\`. The notification behind an entry, with its status and delivery\
> history, is fetched with \`fields=notification\`.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **notification** is one outbound or inbound delivery — an email that leaves the system because\nsomething happened on a ticket, or a message that arrived. They are created by the system, never by a\nclient; these endpoints exist to see what happened and to push a failed delivery back into the queue.\n\n| Status | Meaning |\n| --- | --- |\n| `PENDING` | waiting for its next attempt |\n| `DELIVERING` | being handed to the transport right now |\n| `DELIVERED` | done |\n| `DEAD` | given up on after repeated failures; `lastError` says why |\n","name":"notification"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.ListNotificationsResponse-domain_UserNotification":{"properties":{"count":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/domain.UserNotification"},"type":"array","uniqueItems":false}},"type":"object"},"domain.UserNotification":{"properties":{"createdAt":{"description":"Sortable: the feed's canonical order (matches the timestamp shown to the user).","type":"string"},"id":{"description":"userId is NOT exposed — it is the owner Scope (server-enforced).","type":"integer"},"notification":{"$ref":"#/components/schemas/domain.Notification"},"notificationId":{"type":"integer"},"readAt":{"type":"string"},"userId":{"type":"integer"}},"type":"object"},"domain.Notification":{"properties":{"attempts":{"type":"integer"},"channel":{"$ref":"#/components/schemas/domain.Channel"},"channelId":{"type":"integer"},"config":{"items":{"type":"integer"},"type":"array","uniqueItems":false},"createdAt":{"type":"string"},"deliveredAt":{"type":"string"},"direction":{"$ref":"#/components/schemas/domain.NotificationDirection"},"event":{"$ref":"#/components/schemas/domain.Event"},"eventId":{"type":"integer"},"externalMessageId":{"type":"string"},"id":{"type":"integer"},"identity":{"$ref":"#/components/schemas/domain.Identity"},"identityId":{"type":"integer"},"lastError":{"type":"string"},"nextAttemptAt":{"type":"string"},"payload":{"items":{"type":"integer"},"type":"array","uniqueItems":false},"status":{"$ref":"#/components/schemas/domain.NotificationStatus"},"tenantId":{"type":"integer"}},"type":"object"},"domain.Channel":{"properties":{"active":{"type":"boolean"},"createdAt":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ChannelKind"},"name":{"type":"string"},"purpose":{"$ref":"#/components/schemas/domain.ChannelPurpose"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"updatedAt":{"type":"string"}},"type":"object"},"domain.ChannelKind":{"enum":["","EMAIL","WEBHOOK","TEAMS","SMS","WHATSAPP","WEBCHAT","NOTICE"],"type":"string"},"domain.ChannelPurpose":{"enum":["","THREAD","TICKET","NOTIFICATION"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.NotificationDirection":{"enum":["INBOUND","OUTBOUND"],"type":"string"},"domain.Event":{"properties":{"actorId":{"type":"integer"},"actorSnapshot":{"description":"ActorSnapshot is the actor's display summary, frozen at emit. The actor id\n(ActorID) is kept for filtering/audit; ActorSnapshot is what reads render.","items":{"type":"integer"},"type":"array","uniqueItems":false},"aggregateChanges":{"items":{"type":"integer"},"type":"array","uniqueItems":false},"aggregateId":{"type":"integer"},"aggregateSnapshot":{},"aggregateType":{"type":"string"},"attempts":{"type":"integer"},"eventType":{"$ref":"#/components/schemas/domain.EventType"},"id":{"type":"integer"},"lastError":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"nextAttemptAt":{"type":"string"},"occurredAt":{"type":"string"},"publishedAt":{"type":"string"},"scopeId":{"type":"integer"},"scopeType":{"type":"string"},"status":{"$ref":"#/components/schemas/domain.EventStatus"},"tenantId":{"type":"integer"}},"type":"object"},"domain.EventType":{"enum":["CREATED","UPDATED","DELETED"],"type":"string"},"domain.EventStatus":{"enum":["PENDING","PUBLISHING","PUBLISHED","DEAD"],"type":"string"},"domain.Identity":{"properties":{"createdAt":{"type":"string"},"groups":{"items":{"$ref":"#/components/schemas/domain.Group"},"type":"array","uniqueItems":false},"id":{"description":"id is the only queryable field — Identity is an internal skeleton (a global,\ntenant-less credential table with no user-facing list); the generic Query is\nused only for by-id loads. Type/value lookups stay bespoke (they hash the value).","type":"integer"},"type":{"$ref":"#/components/schemas/domain.IdentityType"},"value":{"type":"string"},"verifiedAt":{"type":"string"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"domain.IdentityType":{"enum":["","EMAIL","PHONE","TOKEN","URL"],"type":"string"},"domain.NotificationStatus":{"enum":["PENDING","DELIVERING","DELIVERED","DEAD"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/notifications":{"get":{"description":"Returns the caller's own notification feed — one entry per notification that was addressed to them,\nnewest last unless `sort` says otherwise. Entries of other users are never returned, whatever the\nfilter says.\n\n**Filterable** — `id`, `userId`, `notificationId`, `readAt`.\n\n**Sortable** — `id`, `createdAt`.\n\n**Searchable** — nothing yet.\n\n`readAt` is when the caller marked the entry as read and is empty while it is unread — unread entries\nare `{\"field\":\"readAt\",\"op\":\"isNull\"}`. The notification behind an entry, with its status and delivery\nhistory, is fetched with `fields=notification`.\n","operationId":"listNotifications","parameters":[{"description":"JSON filter expression","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Free-text term — no effect here","in":"query","name":"search","schema":{"type":"string"}},{"description":"Comma-separated field:direction terms","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Selection of fields and relations","in":"query","name":"fields","schema":{"type":"string"}},{"description":"Number of entries to skip","in":"query","name":"offset","schema":{"default":0,"type":"integer"}},{"description":"Page size, 1 to 100","in":"query","name":"limit","schema":{"default":100,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ListNotificationsResponse-domain_UserNotification"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"List notifications","tags":["notification"]}}}}
```
## Get a notification
> Returns a single notification — the delivery itself, not a feed entry: which channel and address it\
> went to, how often it was attempted, when it was delivered and what the last error was.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **notification** is one outbound or inbound delivery — an email that leaves the system because\nsomething happened on a ticket, or a message that arrived. They are created by the system, never by a\nclient; these endpoints exist to see what happened and to push a failed delivery back into the queue.\n\n| Status | Meaning |\n| --- | --- |\n| `PENDING` | waiting for its next attempt |\n| `DELIVERING` | being handed to the transport right now |\n| `DELIVERED` | done |\n| `DEAD` | given up on after repeated failures; `lastError` says why |\n","name":"notification"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.GetNotificationResponse-domain_Notification":{"properties":{"data":{"$ref":"#/components/schemas/domain.Notification"}},"type":"object"},"domain.Notification":{"properties":{"attempts":{"type":"integer"},"channel":{"$ref":"#/components/schemas/domain.Channel"},"channelId":{"type":"integer"},"config":{"items":{"type":"integer"},"type":"array","uniqueItems":false},"createdAt":{"type":"string"},"deliveredAt":{"type":"string"},"direction":{"$ref":"#/components/schemas/domain.NotificationDirection"},"event":{"$ref":"#/components/schemas/domain.Event"},"eventId":{"type":"integer"},"externalMessageId":{"type":"string"},"id":{"type":"integer"},"identity":{"$ref":"#/components/schemas/domain.Identity"},"identityId":{"type":"integer"},"lastError":{"type":"string"},"nextAttemptAt":{"type":"string"},"payload":{"items":{"type":"integer"},"type":"array","uniqueItems":false},"status":{"$ref":"#/components/schemas/domain.NotificationStatus"},"tenantId":{"type":"integer"}},"type":"object"},"domain.Channel":{"properties":{"active":{"type":"boolean"},"createdAt":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ChannelKind"},"name":{"type":"string"},"purpose":{"$ref":"#/components/schemas/domain.ChannelPurpose"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"updatedAt":{"type":"string"}},"type":"object"},"domain.ChannelKind":{"enum":["","EMAIL","WEBHOOK","TEAMS","SMS","WHATSAPP","WEBCHAT","NOTICE"],"type":"string"},"domain.ChannelPurpose":{"enum":["","THREAD","TICKET","NOTIFICATION"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.NotificationDirection":{"enum":["INBOUND","OUTBOUND"],"type":"string"},"domain.Event":{"properties":{"actorId":{"type":"integer"},"actorSnapshot":{"description":"ActorSnapshot is the actor's display summary, frozen at emit. The actor id\n(ActorID) is kept for filtering/audit; ActorSnapshot is what reads render.","items":{"type":"integer"},"type":"array","uniqueItems":false},"aggregateChanges":{"items":{"type":"integer"},"type":"array","uniqueItems":false},"aggregateId":{"type":"integer"},"aggregateSnapshot":{},"aggregateType":{"type":"string"},"attempts":{"type":"integer"},"eventType":{"$ref":"#/components/schemas/domain.EventType"},"id":{"type":"integer"},"lastError":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"nextAttemptAt":{"type":"string"},"occurredAt":{"type":"string"},"publishedAt":{"type":"string"},"scopeId":{"type":"integer"},"scopeType":{"type":"string"},"status":{"$ref":"#/components/schemas/domain.EventStatus"},"tenantId":{"type":"integer"}},"type":"object"},"domain.EventType":{"enum":["CREATED","UPDATED","DELETED"],"type":"string"},"domain.EventStatus":{"enum":["PENDING","PUBLISHING","PUBLISHED","DEAD"],"type":"string"},"domain.Identity":{"properties":{"createdAt":{"type":"string"},"groups":{"items":{"$ref":"#/components/schemas/domain.Group"},"type":"array","uniqueItems":false},"id":{"description":"id is the only queryable field — Identity is an internal skeleton (a global,\ntenant-less credential table with no user-facing list); the generic Query is\nused only for by-id loads. Type/value lookups stay bespoke (they hash the value).","type":"integer"},"type":{"$ref":"#/components/schemas/domain.IdentityType"},"value":{"type":"string"},"verifiedAt":{"type":"string"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"domain.IdentityType":{"enum":["","EMAIL","PHONE","TOKEN","URL"],"type":"string"},"domain.NotificationStatus":{"enum":["PENDING","DELIVERING","DELIVERED","DEAD"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/notifications/{id}":{"get":{"description":"Returns a single notification — the delivery itself, not a feed entry: which channel and address it\nwent to, how often it was attempted, when it was delivered and what the last error was.\n","operationId":"getNotification","parameters":[{"description":"Notification id","in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"description":"Selection of fields and relations","in":"query","name":"fields","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.GetNotificationResponse-domain_Notification"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get a notification","tags":["notification"]}}}}
```
## Retry a failed delivery
> Puts a failed delivery back into the queue: the notification is set to \`PENDING\`, its last error is\
> cleared and the next attempt is scheduled immediately. Answers with \`202\`.\
> \
> Only an \*\*outbound\*\* notification that has been given up on (\`DEAD\`) is taken back. Anything else is\
> left untouched — the request still answers with \`202\`, so check the notification afterwards if it\
> matters.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **notification** is one outbound or inbound delivery — an email that leaves the system because\nsomething happened on a ticket, or a message that arrived. They are created by the system, never by a\nclient; these endpoints exist to see what happened and to push a failed delivery back into the queue.\n\n| Status | Meaning |\n| --- | --- |\n| `PENDING` | waiting for its next attempt |\n| `DELIVERING` | being handed to the transport right now |\n| `DELIVERED` | done |\n| `DEAD` | given up on after repeated failures; `lastError` says why |\n","name":"notification"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/notifications/{id}/retry":{"post":{"description":"Puts a failed delivery back into the queue: the notification is set to `PENDING`, its last error is\ncleared and the next attempt is scheduled immediately. Answers with `202`.\n\nOnly an **outbound** notification that has been given up on (`DEAD`) is taken back. Anything else is\nleft untouched — the request still answers with `202`, so check the notification afterwards if it\nmatters.\n","operationId":"retryNotification","parameters":[{"description":"Notification id","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Retry a failed delivery","tags":["notification"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://hub.equipme.io/development/api-reference-app/notification.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.