Skip to main content
Resend
40 actions · 20 events · 2 auth methods
Marketing

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Uses a secret API key as a bearer token. Keys can be scoped to full access or sending-only and optionally restricted to…

Connector Profile · OAuth 2.0

Authorization code flow with PKCE. Requires registering an OAuth client with Resend. Scopes are either emails:send or fu…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
|
40 actions
Action
Description
Required scopes
Create API Key
Create an API key with an optional permission tier and domain restriction; the token is returned only once.
List API Keys
List all API keys for the account.
Update API Key
Rename an existing API key.
Delete API Key
Permanently delete an API key so it can no longer authenticate requests.
Create Broadcast
Create a broadcast email targeted at a segment, optionally sending it immediately.
Send Broadcast
Send or schedule an existing broadcast.
Retrieve Broadcast
Retrieve a single broadcast by its id.
List Broadcasts
List all broadcasts in the account.
Update Broadcast
Update an existing broadcast.
Delete Broadcast
Permanently delete a broadcast that has not been sent.
Create Contact
Add a contact with optional name, custom properties, segment membership and topic subscriptions.
Retrieve Contact
Retrieve a single contact by id or email address.
List Contacts
List contacts, optionally filtered by segment.
Update Contact
Update an existing contact by id or email address.
Delete Contact
Remove a contact from the audience by id or email address.
Create Contact Property
Define a custom contact property so its key can be set on contacts.
List Contact Properties
List the custom contact property definitions in the account.
Create Domain
Add a new sending domain and receive the DNS records needed to verify it.
Verify Domain
Trigger DNS verification for a domain.
Retrieve Domain
Retrieve a single domain by its id.
List Domains
List all domains in the account.
Update Domain
Update a domain’s tracking and TLS settings.
Delete Domain
Remove a domain so it can no longer be used to send email.
Send Email
Send a single email through Resend.
Send Batch Emails
Send up to 100 emails in a single batch request.
Retrieve Email
Retrieve a single sent email by its id.
List Emails
List sent emails for the account.
Update Email
Update a scheduled email, such as its send time.
Cancel Email
Cancel a scheduled email that has not yet been sent.
Create Segment
Create a segment used to group contacts for broadcasts.
Retrieve Segment
Retrieve a single segment by its id.
List Segments
List all segments in the account.
Update Segment
Rename an existing segment.
Delete Segment
Permanently delete a segment from the account.
Add Suppression
Add a single email address to the suppression list to stop future sends.
Retrieve Suppression
Retrieve a single suppression by its id.
List Suppressions
List all suppressed email addresses.
Remove Suppression
Remove a single suppression by its id.
Add Batch Suppressions
Add multiple email addresses to the suppression list in one request.
Remove Batch Suppressions
Remove multiple suppressions in one request.

Events

|
20 events
Event
Description
Tags
Email Sent
Fired when the Resend API request to send an email succeeds. The data object carries email_id, from, to, and subject.
EmailsWebhooks
Email Delivered
Fired when an email is successfully delivered to the recipient’s mail server.
EmailsWebhooks
Email Delivery Delayed
Fired when an email could not be delivered due to a temporary issue and delivery is delayed.
EmailsWebhooks
Email Complained
Fired when an email is delivered but the recipient marks it as spam.
EmailsWebhooks
Email Bounced
Fired when the recipient’s mail server permanently rejects the email.
EmailsWebhooks
Email Opened
Fired when the recipient opens the email (open tracking must be enabled).
EmailsWebhooks
Email Clicked
Fired when the recipient clicks a link in the email (click tracking must be enabled).
EmailsWebhooks
Email Failed
Fired when an email fails to send due to an error.
EmailsWebhooks
Email Received
Fired when Resend successfully receives an inbound email.
EmailsWebhooks
Email Scheduled
Fired when an email is scheduled to be sent at a future time.
EmailsWebhooks
Email Suppressed
Fired when an email is suppressed by Resend (the recipient is on the suppression list).
EmailsWebhooks
Contact Created
Fired when a contact is created.
ContactsWebhooks
Contact Updated
Fired when a contact is updated.
ContactsWebhooks
Contact Deleted
Fired when a contact is deleted.
ContactsWebhooks
Contact Topics Updated
Fired when a contact’s topic subscriptions change.
ContactsWebhooks
Domain Created
Fired when a sending domain is created.
DomainsWebhooks
Domain Updated
Fired when a sending domain is updated.
DomainsWebhooks
Domain Deleted
Fired when a sending domain is deleted.
DomainsWebhooks
Suppression Added
Fired when an email address is added to the suppression list.
SuppressionsWebhooks
Suppression Removed
Fired when an email address is removed from the suppression list.
SuppressionsWebhooks