# `bird whatsapp agents notifications create`

## Usage

```bash
bird whatsapp agents notifications create <number-id> [flags]
```

## Description

Send an agent a notification

Tell the agent on this WhatsApp number that something happened in your systems for one contact, such as a payment landing or an order shipping, so it can write to them about it. The notification is handed to WhatsApp in the background; read it back with `bird whatsapp agents notifications get` to see whether the agent acted on it.

Build the request from flags, a JSON WhatsAppAgentNotificationCreate body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.

## Examples

```bash
# print the body shape (no credentials needed)
bird whatsapp agents notifications create --example

# the body it prints:
```

```json
{
  "description": "Order 88213 left the warehouse and arrives on Thursday.",
  "name": "order_shipped",
  "payload": "{\"order_id\":\"88213\",\"carrier\":\"ACME Courier\",\"eta\":\"2026-10-02\"}",
  "to": "+14155551234"
}
```

## Options

#### Request

| Name                | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| `--body-file`       | Read the JSON request body from this file; "-" reads stdin   |
| `--example`         | Print a complete example request body, then exit             |
| `--dry-run`         | Print the resolved request without sending it, then exit     |
| `--idempotency-key` | Deduplication key; a retry with the same key won't act twice |

#### Options

| Name                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--to`              | The contact the notification is about: a phone number in E.164 format (for example +14155551234), or the contact's business-scoped user ID (for example US.13491208655302741918), the same forms a message's to accepts. A phone number is normalized before the call reaches WhatsApp, so spacing does not matter. WhatsApp documents a phone number for this call; a business-scoped user ID is passed through as given. (required; or in --body-file) |
| `--name`            | Your own name for what happened, such as payment\_received or order\_shipped. The agent reads it as the kind of thing that happened, so keep one name per kind. WhatsApp calls this the event type. (required; or in --body-file)                                                                                                                                                                                                                        |
| `--description`     | What happened, in a sentence the agent can tell the contact. (required; or in --body-file)                                                                                                                                                                                                                                                                                                                                                               |
| `--payload`         | Details the agent may draw on when it writes to the contact, as one JSON string. WhatsApp passes it to the agent unchanged and does not read it itself. (required; or in --body-file)                                                                                                                                                                                                                                                                    |
| `--response-schema` | Print the fields this command returns, then exit                                                                                                                                                                                                                                                                                                                                                                                                         |

## Related

| Name                                                                                                | Description                             |
| --------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [`bird whatsapp agents notifications get`](/docs/cli/reference/whatsapp-agents-notifications-get)   | Get a notification sent to an agent     |
| [`bird whatsapp agents notifications list`](/docs/cli/reference/whatsapp-agents-notifications-list) | List the notifications sent to an agent |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)