> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a notifier > Creates a notifier destination in a project. Choose `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK` and provide the matching destination fields. > [!NOTE] > > **Guia relacionado**: guia de Notifiers. Consulte o [guia de Notifiers](/docs/pt-BR/ai-studio/observability/notifiers.md) para um passo a passo com exemplos. ## OpenAPI ````yaml post /v2/notifiers openapi: 3.1.0 info: title: Toqan Router API version: '2.0' description: Toqan Router API documentation servers: - url: https://router.toqan.ai/eu description: Frankfurt (Europe) - url: https://router.toqan.ai/br description: São Paulo (Brazil) security: - ApiKey: [] tags: - description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. name: API keys - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Telemetry description: >- Unified query envelope for traces, metrics, and logs. One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - name: Views description: Saved filters and columns for workspace observability pages. - description: List models available through the AI Router. name: Models - name: Alerts description: >- Alerts evaluate a telemetry metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the Toqan Router model catalog: every model Toqan Router offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Monitors description: >- Monitors are custom observability dashboards for traces, runtime metrics, and logs. Each monitor holds widgets that chart one telemetry query. List the metrics, operations, and dimensions available to your workspace with `GET /v3/telemetry/capabilities`, or start from a preset with `GET /v2/monitors/presets`. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Responses - name: Embeddings - description: Beta. Run typed classification questions against a classify model. name: Classify - description: Beta. Run classification decisions with the classify contract. name: Decisions - description: >- Run large offline workloads as JSONL batches and download OpenAI-compatible result files. name: Batches paths: /v2/notifiers: post: tags: - Notifiers summary: Create a notifier description: >- Creates a notifier destination in a project. Choose `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK` and provide the matching destination fields. operationId: NotifierCreate requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNotifierRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateNotifierResponse' '401': description: >- Authentication required. See https://router.toqan.ai/docs/reference/errors for the error codes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKey: [] x-code-samples: - lang: curl label: Core - Create email notifier source: | curl --request POST \ --url 'https://router.toqan.ai/eu/v2/notifiers' \ --header "Authorization: Bearer $TOQAN_API_KEY" \ --header 'Content-Type: application/json' \ --data '{ "project_id": "proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V", "display_name": "Production alerts", "type": "NOTIFIER_TYPE_EMAIL", "emails": ["ops@example.com", "alerts@example.com"], "metadata": {"environment": "production"} }' components: schemas: CreateNotifierRequest: required: - display_name - type type: object properties: project_id: type: string description: >- Optional. Workspace-scoped callers may set this to create a project-scoped notifier, or omit it for a workspace-wide notifier. Project-scoped API keys create in the API key's project. display_name: type: string description: Required. Human-readable notifier name. example: Deployment alerts metadata: type: object description: Optional. Custom JSON metadata stored with the notifier. type: $ref: '#/components/schemas/NotifierType' description: >- Required. Destination type. Use `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK`. example: NOTIFIER_TYPE_SLACK_WEBHOOK emails: type: array items: type: string description: >- Required when `type` is `NOTIFIER_TYPE_EMAIL`. Omit for other notifier types. incoming_webhook_url: type: string description: >- Required when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. Omit for other notifier types. example: https://hooks.slack.com/services/T0000/B0000/example-token webhook_url: type: string description: >- Required when `type` is `NOTIFIER_TYPE_WEBHOOK`. Omit for other notifier types. headers: type: object description: >- Optional generic webhook headers. Each value may be a string or `{ "secret": true, "value": "..." }`. description: >- Create notifier request. `project_id`, `display_name`, and `type` are always required. The destination field required by `type` is captured in `oneOf`. oneOf: - title: Email notifier create request type: object description: '`emails` is required when `type` is `NOTIFIER_TYPE_EMAIL`.' required: - type - emails properties: type: type: string enum: - NOTIFIER_TYPE_EMAIL emails: type: array items: type: string description: >- Required when `type` is `NOTIFIER_TYPE_EMAIL`. Omit for other notifier types. - title: Slack webhook notifier create request type: object description: >- `incoming_webhook_url` is required when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. required: - type - incoming_webhook_url properties: type: type: string enum: - NOTIFIER_TYPE_SLACK_WEBHOOK incoming_webhook_url: type: string description: >- Required when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. Omit for other notifier types. - title: Generic webhook notifier create request type: object description: >- `webhook_url` is required when `type` is `NOTIFIER_TYPE_WEBHOOK`; `headers` is optional. required: - type - webhook_url properties: type: type: string enum: - NOTIFIER_TYPE_WEBHOOK webhook_url: type: string description: >- Required when `type` is `NOTIFIER_TYPE_WEBHOOK`. Omit for other notifier types. CreateNotifierResponse: required: - notifier type: object properties: notifier: $ref: '#/components/schemas/Notifier' ErrorResponse: type: object properties: message: type: string description: Human-readable error message. code: type: integer description: Numeric error code, when one is available. details: type: array items: {} description: Additional error details, when the service reports any. required: - message NotifierType: type: string enum: - NOTIFIER_TYPE_EMAIL - NOTIFIER_TYPE_SLACK_WEBHOOK - NOTIFIER_TYPE_WEBHOOK example: NOTIFIER_TYPE_SLACK_WEBHOOK Notifier: required: - _id - display_name - created_at - updated_at - type type: object properties: _id: type: string description: Unique notifier identifier assigned by Toqan Router. project_id: type: string description: >- Project that contains the notifier. Empty for workspace-wide notifiers. display_name: type: string description: Human-readable notifier name. created_at: type: string description: Time when the notifier was created. format: date-time updated_at: type: string description: Time when the notifier was last updated. format: date-time created_by_id: type: string description: User ID that created the notifier. updated_by_id: type: string description: User ID that last updated the notifier. metadata: type: object description: Custom JSON metadata stored with the notifier. type: $ref: '#/components/schemas/NotifierType' description: >- Notifier destination type. Use `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK`. emails: type: array items: type: string description: Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`. incoming_webhook_url: type: string description: >- Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. webhook_url: type: string description: Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`. headers: type: object description: >- Optional HTTP headers for generic webhooks. Each entry may be a string value or an object with `secret` and `value`. description: >- Notifier resource. The destination field present on the resource depends on `type` and is captured in `oneOf`. oneOf: - title: Email notifier type: object description: '`emails` is present for email notifiers.' required: - type - emails properties: type: type: string enum: - NOTIFIER_TYPE_EMAIL emails: type: array items: type: string description: Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`. - title: Slack webhook notifier type: object description: '`incoming_webhook_url` is present for Slack webhook notifiers.' required: - type - incoming_webhook_url properties: type: type: string enum: - NOTIFIER_TYPE_SLACK_WEBHOOK incoming_webhook_url: type: string description: >- Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. - title: Generic webhook notifier type: object description: >- `webhook_url` is present for generic webhook notifiers; `headers` is optional. required: - type - webhook_url properties: type: type: string enum: - NOTIFIER_TYPE_WEBHOOK webhook_url: type: string description: Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.