Actions84
- Avatar Actions
- Document Actions
- Function Actions
- Messaging Actions
- Create APNS Provider
- Create Email
- Create FCM Provider
- Create Mailgun Provider
- Create MSG91 Provider
- Create Provider
- Create Push
- Create Sendgrid Provider
- Create SMS
- Create SMTP Provider
- Create Subscriber
- Create Telesign Provider
- Create Textmagic Provider
- Create Topic
- Create Twilio Provider
- Create Vonage Provider
- Delete Provider
- Delete Subscriber
- Delete Topic
- Get Message
- Get Provider
- Get Subscriber
- Get Topic
- List Message Logs
- List Messages
- List Provider Logs
- List Providers
- List Subscriber Logs
- List Subscribers
- List Targets
- List Topic Logs
- List Topics
- Update APNS Provider
- Update Email
- Update FCM Provider
- Update Mailgun Provider
- Update MSG91 Provider
- Update Provider
- Update Push
- Update Sendgrid Provider
- Update SMS
- Update SMTP Provider
- Update Telesign Provider
- Update Textmagic Provider
- Update Topic
- Update Twilio Provider
- Update Vonage Provider
- Storage Actions
- Token Actions
- Users Actions
Overview
This node operation allows you to create a Sendgrid messaging provider within the Appwrite platform using n8n. It is designed to configure and register a new Sendgrid email provider by specifying essential details such as API key, sender information, and enabling status.
Common scenarios where this node is beneficial include:
- Automating the setup of Sendgrid providers for sending transactional or marketing emails.
- Integrating Sendgrid email services into workflows that require dynamic creation or management of email providers.
- Centralizing email provider configuration in Appwrite through automated workflows.
Practical example:
- Automatically creating a Sendgrid provider when onboarding a new client or project, supplying their unique API key and sender details, so that subsequent email campaigns or notifications can be sent via this configured provider.
Properties
| Name | Meaning |
|---|---|
| Provider ID | Unique identifier for the provider. Use unique() to generate a random ID or provide a custom ID. |
| Provider Name | The display name for the Sendgrid provider. |
| API Key | The Sendgrid API key used for authenticating requests to Sendgrid. |
| From Name | The sender's name that will appear on outgoing emails. |
| From Email | The sender's email address used in outgoing emails. |
| Reply To Name | The name shown in the reply-to field of emails. |
| Reply To Email | The email address used in the reply-to field. |
| Enabled | Boolean flag indicating whether the provider is enabled (active) or not. |
| Additional Fields | Optional extra settings including: - BCC: Comma-separated list of BCC email addresses - CC: Comma-separated list of CC email addresses - Draft: Whether the message is a draft - HTML: Whether the email content is HTML - Scheduled At: Scheduled delivery time in ISO 8601 format - Targets, Topics, Users: Comma-separated lists of IDs for targeting |
Output
The output is a JSON object representing the created Sendgrid provider resource as returned by the Appwrite API. This typically includes details such as the provider ID, name, type, configuration parameters, and enabled status.
No binary data output is produced by this operation.
Dependencies
- Requires an active Appwrite account with access to the Messaging service.
- Needs valid credentials for the Appwrite API configured in n8n, including URL, project ID, and an API key credential.
- A valid Sendgrid API key must be provided to authenticate and authorize the creation of the Sendgrid provider.
Troubleshooting
- Missing or invalid API key: If the Sendgrid API key is incorrect or missing, the provider creation will fail. Ensure the API key is valid and has appropriate permissions.
- Provider ID conflicts: Using a non-unique provider ID that already exists may cause errors. Use
unique()to auto-generate a unique ID or ensure your custom ID does not conflict. - Invalid email formats: The "From Email" and "Reply To Email" fields must be valid email addresses; otherwise, the API may reject the request.
- Disabled provider: If the "Enabled" flag is set to false, the provider will be created but inactive, which might lead to unexpected behavior if you try to send emails immediately.
- API connectivity issues: Network problems or incorrect Appwrite credentials can prevent successful API calls. Verify network access and credential correctness.