Where do you find the API?

Go to Settings → API. The page has three tabs: Keys, Webhooks, and Activity. Only users with the Owner role can see this page.

  • Base URL: https://api.v2.xendy.me/v1
  • Documentation (OpenAPI): https://api.v2.xendy.me/v1/openapi.json. You can open this without an API key and load it into tools like Postman.

Creating an API key

  1. On the Keys tab, click Create API key.
  2. Give the key a recognizable Name, for example Webshop integration.
  3. Choose what the key is allowed to do per data type: Read and/or Write. Don't grant more permissions than your integration needs.
  4. Click Create. Copy the key and click I have saved the value. You only see the key once.

Include the key in every request as a header: Authorization: Bearer xnd_live_.... The key automatically determines which account is involved.

Data typeReadWrite
ContactsRetrieve contactsCreate, update, subscribe and unsubscribe contacts, and add or remove them from a list
Mail lists & audiencesRetrieve lists and segmentsCreate a list
CampaignsRetrieve campaigns–
Send–Send or schedule an existing campaign as a newsletter
ReportsRetrieve statistics for newsletters and automations–
AccountThe token for abandoned carts (required for the WordPress plugin)–
WebhooksRetrieve webhooksRegister and delete webhooks

Note: with Send (write), the key can send real newsletters to your contacts. Only enable this if your integration needs to be able to do that.

Revoking an API key

In the list of keys you can see each key's Permissions and when it was last used (Last used). If you no longer want to use a key, click the trash icon under Delete and confirm. Integrations using the key will stop working immediately. This cannot be undone.

Webhooks: Xendy sends you a message

With a webhook, Xendy automatically sends a POST request to your URL when something happens. You can choose from three events:

  • DNS records no longer correct (dns-records.failed)
  • DNS records recovered (dns-records.recovered)
  • Webshop import failed (webshop-import.failed)
  1. On the Webhooks tab, click Add webhook.
  2. Enter the URL (https only) and choose the Events.
  3. Click Add. Copy the webhook secret that appears: you only see it once.

Every message is JSON with id, event, created_at, and data, and includes the headers Xendy-Event, Xendy-Delivery, and Xendy-Signature. You use the signature to verify that the message really came from Xendy. Xendy-Signature has the format t=<timestamp>,v1=<signature>: the signature is an HMAC-SHA256 of <t>.<body> using your secret. Reject messages where t is older than 5 minutes. A JavaScript example is included in the documentation.

Respond within 10 seconds with a 2xx status code. If delivery fails, Xendy will retry after 1, 5, and 30 minutes. If five events in a row fail completely, Xendy sets the webhook to Disabled. Every attempt is visible on the Activity tab, under Outgoing webhook.

Limits

  • 120 requests per minute per key
  • Write actions: 60 per minute
  • Send: 10 per minute

If you exceed these limits, you'll receive HTTP 429. When sending a newsletter, include an Idempotency-Key header: within 24 hours, the same value returns the same newsletter instead of triggering a second send.

Frequently asked questions

No. Xendy only shows a key once and doesn't store it in a readable format. Create a new key, add it to your integration, and then revoke the old one.

No. An API key (xnd_live_...) only works on the API, and an MCP key (xnd_mcp_...) only works for AI assistants via MCP. Using an MCP key on the API will return error code 401.

That means five events in a row were not delivered, even after retries. On the Activity tab (type Outgoing webhook) you can see what your server responded with. Fix the issue, delete the webhook, and add it again.

On the Webhooks tab you set up messages that Xendy sends to your system. If you want to send contacts to Xendy yourself, use Add contacts → Via a webhook in a segment. That works with its own token instead of an API key. See Connecting via Zapier.

On the Activity tab you can see every call with its status, duration, and the data sent. See Viewing API activity.

Joeri Ras

Written by

Joeri Ras

Founder & co-owner @ Xendy

Prefer to talk directly?

Related articles

Integrations

Connect Gravity Forms to Xendy

With Gravity Forms you can easily create forms in WordPress. By connecting it to Xendy, submissions automatically end up in a static segment, so you can use new contacts right away for newsletters or email automations.

Read more
Integrations

Connect your Lightspeed store to Xendy

By connecting Lightspeed to Xendy, customer, order, and product data are automatically synchronized every night. This allows you to create segments based on purchasing behavior and display products directly in your emails. With two scripts in your webshop, you can also follow up on abandoned shopping carts.

Read more
Integrations

Connect your Magento 2 store to Xendy

By connecting Magento 2 to Xendy, customer, order and product data are automatically synchronized every night. This allows you to create segments based on purchasing behavior, display personal product recommendations and follow up on abandoned shopping carts. Please note: abandoned shopping carts only work in Magento 2 for customers who are logged in to your webshop. Xendy retrieves them during the nightly import.

Read more
Integrations

Connect your Shopify store to Xendy

By connecting Shopify to Xendy, your customers, orders, and products will be available in Xendy. This allows you to create segments based on purchasing behavior and add products to your emails. You can connect via the Xendy app in Shopify or with a custom app from the Shopify Dev Dashboard. With the Xendy app, changes come in immediately, abandoned carts work, and unsubscribes sync both ways. With a custom app, your data is updated every night.

Read more