Migrate from Resend

Pidgely serves the Resend REST API at the same paths, with no version prefix. Requests, responses, status codes, the error body ({"statusCode","name","message"}), the Idempotency-Key header and cursor pagination all match. To migrate, switch to the Pidgely SDK for your language (same method names) and swap the API key; your code barely changes.

#Step by step

1. Create an account and an API key. Pidgely keys look like pdg_xxxxxxxx_xxxx…; the SDKs don't check the re_ prefix.
2. Add your domain (POST /domains or the dashboard) and publish the records it returns: DKIM TXT, the return-path MX + SPF TXT, and optionally DMARC. The return path defaults to bounces.<domain>; pass "custom_return_path": "send" to reuse the label you had on Resend. You can keep the Resend records in place during the switch: the DKIM selectors differ, so both coexist.
3. Verify the domain (POST /domains/{id}/verify).
4. Switch your code to the Pidgely SDK (or, temporarily, point the Resend SDK at Pidgely) and deploy.
5. Recreate webhooks with POST /webhooks and update the signing secret in your receiver. Verification code doesn't change.
6. Import contacts and segments if you use broadcasts (POST /contacts is an upsert, so re-running an import is safe), and copy your suppression list (POST /suppressions/batch/add) so bounced and unsubscribed addresses stay suppressed.
7. Recreate templates and publish them; aliases keep your send code unchanged.

#Switch to the Pidgely SDK (recommended)

The official Pidgely SDKs mirror the Resend SDKs' method names, arguments and { data, error } results, so switching is a change of package, import and key:

- import { Resend } from 'resend';
- const resend = new Resend(process.env.RESEND_API_KEY);
+ import { Pidgely } from 'pidgely';
+ const resend = new Pidgely(process.env.PIDGELY_API_KEY);

  const { data, error } = await resend.emails.send({ from, to, subject, html });

1. npm uninstall resend && npm install pidgely (or the package for your language).
2. Rename the import and swap the re_… key for your pdg_… key.
3. If you verify webhooks with the SDK, await the verify call (it is async in the Pidgely SDK).

You also get Pidgely additions such as automatic retries, emails.attachments, apiKeys.update, broadcasts.cancel/duplicate and suppressions.*.

#Keep the Resend SDK for now (base URL per SDK)

If you can't change dependencies yet, the official Resend SDKs also work against Pidgely: set their base URL to https://api.pidgely.com and use a Pidgely key. Plan to switch to the Pidgely SDK afterwards.

#SMTP

See SMTP relay.

#Webhooks

Webhooks created through POST /webhooks use Resend's event names (email.sent, email.delivered, email.delivery_delayed, email.bounced, email.complained, email.failed, email.suppressed, domain.updated, contact.created/updated/deleted) and Resend's payload ({type, created_at, data: {email_id, to[], …}}). They are signed with the same Svix / Standard Webhooks scheme: svix-id, svix-timestamp and svix-signature headers, plus the webhook-* equivalents. resend.webhooks.verify(…) and the Svix libraries therefore work with your whsec_… secret. See Webhooks.

#Supported resources

#Not supported yet

Each of these fails loudly rather than silently, so a migration can't misbehave unnoticed:

• Open and click tracking. open_tracking/click_tracking are accepted and reported as false. email.opened/email.clicked webhooks can be created but never fire.
• Topics. A non-empty topic_id or topics is rejected with 422.
• Inbound and receiving. Inboxes, received emails, capabilities.receiving: enabled (rejected) and email.received.
• Other endpoints. Automations, events, contact properties as a separate resource, contact imports, logs, OAuth, POST /emails/{id}/share, GET /emails/metrics, broadcast recipients and clicked links, domain claims, and webhook event history and replay.

#Differences worth knowing

• Delete endpoints return 200 with {"object","id","deleted":true}, as Resend does. The native /v1 API returns 204.
• Validation errors are 422 validation_error. A From domain that is not verified, a plan limit, or a paused account returns 403 validation_error. A sending_access key on a full-access endpoint returns 401 restricted_api_key.
• GET /emails/{id} reads from the primary database, so it is consistent immediately after a send. List endpoints may use a read replica.
• Idempotent-Replayed: true marks a replayed idempotent response.
• email.sent means accepted and queued; email.delivered confirms the receiving server accepted it.
• Suppressions apply to every stream: an unsubscribe also stops transactional mail to that address.