Create Inbound Address
senderkit_inbound_addresses_createCreate a new inbound email address that receives mail for the workspace and, optionally, forwards it and/or fires a webhook on receipt. Enforces the workspace's plan limit and validates forwardTo/webhookEndpointId.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| context | Yes | Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization." | |
| domainId | No | Which verified inbound domain to mint on (from senderkit_inbound_domains_list). Omit for the workspace's shared {slug}.in.senderkit.email domain. | |
| livemode | No | Live mode (default true). Test-mode addresses receive real mail but fan out only to test-mode webhook endpoints, and their forwards are recorded as test sends without real delivery. Every address, test or live, counts toward the plan's inbound-address limit. | |
| forwardTo | No | Email address to forward received mail to. Must be a plausible address and cannot be another inbound address (would create a mail loop). | |
| localPart | No | Local part before the @, e.g. "invoices" for invoices@{slug}.in.senderkit.email — 1-64 chars of a-z, 0-9, dot, underscore, dash, starting and ending alphanumeric (lowercased; some names are reserved). Pass "*" for a catch-all that receives mail for every local part no exact address claims. Omit to mint an unguessable random one. | |
| description | No | Optional internal note describing what this address is for. | |
| webhookEndpointId | No | This workspace's webhook endpoint id to fire message.received events to on receipt — a bound endpoint receives them even if not subscribed, but must be active and match this address's livemode (test-mode addresses bind test-mode endpoints). When unset, events fan out to every active endpoint subscribed to message.received in the address's mode. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Inbound address id (e.g. "inb_…"). | |
| active | Yes | Whether the address currently receives mail. | |
| address | Yes | The full receiving address, e.g. support@acme.in.senderkit.email. | |
| livemode | Yes | Live-mode address (true) or test-mode (false). | |
| createdAt | Yes | When the address was created. | |
| forwardTo | Yes | Address received mail is also forwarded to, or null. | |
| description | Yes | Internal note, or null. |