> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# notification.addToast

API reference for the notification.addToast method.

A method that shows a toast notification to the user.

## Usage

```tsx
import { notification } from '@canva/platform';
import type { ToastRequest } from '@canva/platform';

const showToast = () => {
  const request: ToastRequest = {
    messageText: "Hello world!",
  };
  notification.addToast(request);
};

<Button onClick={() => showToast()}>Show Toast</Button>
```

## Parameters

<Prop.List>
  <Prop name="request" required type="ToastRequest" sourceLineNumbers={[500]}>
    Options for configuring a toast notification.

    <PillAccordion defaultExpanded={true} title={<>Properties of <strong>request</strong></>}>
      <Prop.List>
        <Prop name="messageText" required type="string" sourceLineNumbers={[685]}>
          Text to show within the toast notification.
        </Prop>

        <Prop name="timeoutMs" type="number | string" sourceLineNumbers={[695]}>
          The duration that the notification will be visible.

          If set to `"infinite"`, the notification will be displayed until manually dismissed by the user.

          If set to a number, the notification will automatically disappear after that duration (in milliseconds).

          <Prop.Extras>
            **Default value**: `5000`
          </Prop.Extras>
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>
</Prop.List>

## Returns

The result when a toast notification is successfully added. This is a `Promise` that resolves with the following object:

<Prop.List>
  <Prop name="status" required type="string" sourceLineNumbers={[673]}>
    The status of the request.

    The only valid value is `"completed"`.
  </Prop>
</Prop.List>

## Rate limit

This method has a rate limit of 10 requests every 10 seconds.