> For the complete documentation index, see [llms.txt](https://striga.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://striga.gitbook.io/docs/striga-core/integration/notify.md).

# Notify

Where Striga notifications show. Framework, ox\_lib, Striga Notify or your own.

Config key: `notify` in `config.json`. Default `"framework"`.

## Choices

| Value             | Notifications show in                                              |
| ----------------- | ------------------------------------------------------------------ |
| `"framework"`     | Your framework's notify (QBCore, Qbox, ESX; ox\_lib on standalone) |
| `"ox_lib"`        | ox\_lib notify                                                     |
| `"striga-notify"` | Striga Notify (registers itself when it runs)                      |
| your name         | Your own adapter                                                   |

| Option                   | Default | What it does                                             |
| ------------------------ | ------- | -------------------------------------------------------- |
| `notifyOptions.position` | `""`    | Default position. `""` = the notify system's own setting |
| `notifyOptions.duration` | `5000`  | Duration in ms when a script gives none (1000 to 30000)  |

{% hint style="info" %}
Not every system shows every field. QBCore shows no icon or position. For titles, icons and positions use `"striga-notify"` or `"ox_lib"`.
{% endhint %}

{% content-ref url="/pages/30Qxh8hSWtmcMcFJ3kz4" %}
[Introduction](/docs/striga-notify/introduction.md)
{% endcontent-ref %}

## Your own notify

```json
"notify": "my-notify"
```

Required: `show`. Both client and server.

```lua
-- client: n = { description, title?, type, duration, icon?, iconColor?, position?, id?, sound? }
exports['striga-core']:RegisterAdapter('notify', 'my-notify', {
    show = function(n) -- n.type: info | success | error | warning
        exports['my-notify']:Show(n.title, n.description, n.type, n.duration)
    end,
})

-- server
exports['striga-core']:RegisterAdapter('notify', 'my-notify', {
    show = function(src, n)
        TriggerClientEvent('my-notify:show', src, n.title, n.description, n.type, n.duration)
    end,
})
```

* Old adapters with only `notify(msg, kind, duration)` (server: `notify(src, msg, kind, duration)`) still work. A title is put in front of the text: `Title: text`.
* Core checks the data first. A notification with no text is dropped.
* On the server, core sends at most 20 notifications per second to one player.

{% content-ref url="/pages/0RXg1A8VLG5exRjmpVwb" %}
[Text UI](/docs/striga-core/integration/text-ui.md)
{% endcontent-ref %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://striga.gitbook.io/docs/striga-core/integration/notify.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
