CueDMDocs
Overview

Get started

Overview

What the CueDM API and webhooks do, what they cost, and a first request in five minutes.

What you can build

CueDM answers Instagram comments, story replies and DMs for you. The developer tools let you take what happens there somewhere else, as it happens:

  • add every email a DM collects to your email list or CRM;
  • log each DM sent and each link clicked in a spreadsheet or your warehouse;
  • post to Slack when a DM fails, so someone can reply by hand;
  • connect CueDM to Zapier or Make with a key instead of pasting URLs.

Webhooks and the API

There are two tools. Most integrations only need the first one.

Webhooks

CueDM sends a signed POST to your URL when an event happens. Available on every plan.

Receiving webhooks →

REST API

Your code calls CueDM with a workspace API key to read the workspace and add or remove webhooks. Part of the Studio plan.

API reference →

You can subscribe to these events: dm.sent (dm sent), dm.failed (dm failed), link.clicked (link clicked), contact.created (new contact), contact.email_captured (email captured), bio.subscribed (bio page signup), bio.unsubscribed (bio page unsubscribe). The event reference shows each payload.

Quickstart: your first webhook

The quickest way to see an event arrive takes about five minutes and needs no server of your own.

  1. Get a URL that shows what it receives

    Open webhook.site and copy your unique URL. Later you'll use your own endpoint or a Zapier catch hook instead.

  2. Add it as a webhook in CueDM

    In Settings → Integrations, choose Add webhook, paste the URL, tick DM sent, and save. Copy the signing secret now, because CueDM only shows it once. You need it to verify requests.

  3. Send a test

    Choose Send test on the webhook. A ping event arrives within a few seconds:

    Request body
    {
      "id": "cmg4x0x6d0001l50g8m2k1v7q",
      "event": "ping",
      "workspaceId": "cmfz8o3gq0000l50gk3ah2d9e",
      "occurredAt": "2026-09-29T10:00:00.000Z",
      "data": {
        "message": "Hello from CueDM"
      }
    }
  4. Trigger a real event

    Comment your automation's keyword on your own post from another account. When the DM goes out, a dm.sent event arrives with the automation, the account, the person and what they wrote.

Your first API request

On Studio, create a key in Settings → Integrations → API keys, then ask CueDM which workspace it belongs to:

curl https://cuedm.com/api/v1/me \
  -H "Authorization: Bearer $CUEDM_API_KEY"

Authentication covers keys, rate limits and errors.

Conventions

  • The base URL is https://cuedm.com/api/v1. Requests and responses are JSON.
  • Every response has a success field. When it is true, the result is in data. When it is false, a readable reason is in error.
  • Times are ISO 8601 in UTC, for example 2026-09-29T10:00:00.000Z.
  • IDs are opaque strings. Store them as they are and don't parse them.
  • New fields may be added to responses and payloads at any time, so ignore fields you don't use. A field is never removed or renamed without notice.

Who can set this up

Only workspace owners and admins can add webhooks and create or revoke API keys. If those buttons are missing in Settings, ask an owner to do it or to make you an admin.

Stuck, or something here is wrong? Email support@cuedm.com and a person will answer.