> For the complete documentation index, see [llms.txt](https://legacy-docs.usesmileid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy-docs.usesmileid.com/further-reading/faqs/slack-integration.md).

# Slack Integration

{% hint style="info" %}
You can [poll an API endpoint](/further-reading/faqs/is-there-an-api-i-can-check-to-check-the-status-of-an-id-authority.md) to retrieve the availability status of an ID type.
{% endhint %}

## Slackbot for ID Status Monitoring

The Smile ID Slackbot sends real-time notifications to your Slack workspace whenever an ID authority experiences a service interruption or change in availability. This lets your team stay informed and respond quickly without having to manually check the portal.

### Quick setup

1. Open the **ID API Status** page in the Portal.
2. Click **Add to Slack** and authorize the app.
3. Choose the Slack workspace and channel for alerts.
4. Run `/smileid` in Slack to select countries and ID types.
5. Submit your settings and confirm alerts appear in the channel.

### Prerequisites

Before getting started, ensure you have:

* A Smile ID account with access to the partner portal
* Admin access to a Slack workspace
* A Slack channel dedicated to receiving alerts (e.g. `#alerts-smileid`)

***

### Step 1: Open the ID Authority Status Page

Log in to the Smile ID portal and go to the ID API Status menu in the sidebar:

{% hint style="info" %}
**URL:** <https://portal.usesmileid.com/partner/id_status>
{% endhint %}

You will see a banner prompting you to add the Smile ID Slackbot to your workspace.

<figure><img src="/files/dfr9k36JenH6mmubQXGd" alt=""><figcaption></figcaption></figure>

***

### Step 2: Add the Bot to Slack

Click the **Add to Slack** button. You will be redirected to Slack's authorization page.

<figure><img src="/files/w5uPbYhQCdk8eq8fKMHQ" alt=""><figcaption></figcaption></figure>

On this page:

1. Select your **Slack workspace** from the Workspace dropdown.
2. Choose the **channel** where the bot should post notifications from the Channel for webhook dropdown.
3. Review the listed permissions, then click **Allow**.

{% hint style="warning" %}
The app may show an "App is not approved by Slack" warning. This is standard for apps not listed in the Slack Marketplace and is safe to proceed with.
{% endhint %}

***

### Step 3: Confirm Installation

After clicking Allow, you will see a confirmation screen indicating the bot has been successfully installed.

<figure><img src="/files/CcCWluHkGRZniLaIXhPi" alt=""><figcaption></figcaption></figure>

Head over to your selected Slack channel. The bot will post a welcome message confirming your subscription is active.

<figure><img src="/files/gse32jk4BNdX7TJEWSrG" alt=""><figcaption></figcaption></figure>

***

### Step 4: Configure Notification Settings

To specify which countries and ID types to monitor, type `/smileid` in the channel where the bot was installed and select the command when it appears.

<figure><img src="/files/TlPistkv7xFf8eOqFuhj" alt=""><figcaption></figcaption></figure>

This opens the **Notification Settings** modal. For each country listed, select one or more ID types from the dropdown. All fields are optional — only select the ID types relevant to your integration.

<figure><img src="/files/1QMw8CHNlRAMg61DP2fX" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/OYW1sQIZ6pygqMlk4Udf" alt=""><figcaption></figcaption></figure>

Once you have made your selections, click **Submit**.

***

### Step 5: Verify Your Subscriptions

After submitting, the bot posts a summary of your active subscriptions in the channel, listing each country and its corresponding ID types.

<figure><img src="/files/60ZX4ILdaMdwfiJZ6xz6" alt=""><figcaption></figcaption></figure>

***

### What Alerts Look Like

Whenever a status change is detected for a monitored ID type, the bot posts a message in your channel containing:

* **Country and ID type** affected (e.g. `South Africa - NATIONAL_ID`)
* **Current Status** — the new status: `online`, `offline`, or `interruption`
* **Previous Status** — the status before the change
* A **view in portal** link to see full details on the Smile ID portal

<figure><img src="/files/liZQYRRQS2tGUctKW0KQ" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
You may receive multiple alerts in quick succession if several ID authorities experience status changes around the same time. Each alert is posted as a separate message.
{% endhint %}

***

### Updating Your Notification Preferences

You can update your subscriptions at any time by running `/smileid` again in the channel. The Notification Settings modal will open, allowing you to add or remove ID types.

***

### Troubleshooting

#### Bot is not posting messages

* Ensure the bot was added to the correct channel.
* Confirm the channel is not archived or restricted.
* Re-run `/smileid` to verify your subscriptions are active.

#### `/smileid` command is not available

* The bot must be installed in the workspace before the slash command becomes available.
* If the command does not appear, reinstall the bot from the [ID Authority Status page](https://portal.usesmileid.com/partner/id_status).


---

# 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://legacy-docs.usesmileid.com/further-reading/faqs/slack-integration.md?ask=<question>&goal=<endgoal>
```

`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.