Every operation, generated from the spec

GET/api/v1/api-keys/validate

Check whether an API key is valid and see its status.

Looks up the key passed in the X-Api-Key header and reports whether it is currently valid, along with its name, workspace id, and status - active, revoked, or expired. A key that does not resolve at all still returns 200 with isValid set to false rather than an error; only a request with no X-Api-Key header at all is rejected with 401. Useful for confirming a newly created key works, or for diagnosing why a key you expected to work is being rejected elsewhere.

Requires ApiKey authentication.

Response 200

Responses

curl

curl https://api.communiqueue.com/api/v1/api-keys/validate \
  -H "X-Api-Key: cq_live_..."

Node

const response = await fetch(
  'https://api.communiqueue.com/api/v1/api-keys/validate',
  {
    headers: {
      'X-Api-Key': process.env.COMMUNIQUEUE_API_KEY
    }
  }
)
const result = await response.json()
// result.isValid, result.status ('active' | 'revoked' | 'expired')

POST/api/v1/notifications/preview

Render a template against sample tags without sending anything.

Renders the live (or a pinned) version of the template with the supplied tags and returns the rendered output. Nothing is delivered and no delivery job is created. Only email templates are supported - previewing any other template type returns notifications.unsupported_notification_type. Useful in CI, or in an internal tool that needs to show what a send would look like before it goes out. Omit versionNumber to preview whatever version is currently live.

Requires ApiKey authentication.

Request body

Response 200

Responses

curl

curl -X POST https://api.communiqueue.com/api/v1/notifications/preview \
  -H "X-Api-Key: cq_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "tenantId": "<your workspace id>",
    "templateId": "<your template id>",
    "tags": [{ "key": "firstName", "value": "Ada" }]
  }'

Node

const response = await fetch(
  'https://api.communiqueue.com/api/v1/notifications/preview',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': process.env.COMMUNIQUEUE_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      tenantId: process.env.COMMUNIQUEUE_WORKSPACE_ID,
      templateId: 'welcome-email',
      tags: [{ key: 'firstName', value: 'Ada' }]
    })
  }
)
const preview = await response.json()
// preview.email.renderedContent.subject / .body - what the send would render

POST/api/v1/notifications/send

Queue a templated notification for delivery.

Renders the template named by templateId with the supplied tags and queues it for delivery over whichever channel the template is configured for. The response is 202 Accepted, which means the notification has been queued, not that it has been delivered - track the actual delivery outcome in your workspace's delivery reports. Omit versionNumber to always send whatever version is currently live; pin it only when a specific published version must go out regardless of what gets published afterward. A webhook template additionally requires webhookOptions.urlOverride and a plan that includes webhook delivery.

Requires ApiKey authentication.

Request body

Response 202

Responses

curl

curl -X POST https://api.communiqueue.com/api/v1/notifications/send \
  -H "X-Api-Key: cq_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "tenantId": "<your workspace id>",
    "templateId": "<your template id>",
    "tags": [{ "key": "firstName", "value": "Ada" }]
  }'

Node

const response = await fetch(
  'https://api.communiqueue.com/api/v1/notifications/send',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': process.env.COMMUNIQUEUE_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      tenantId: process.env.COMMUNIQUEUE_WORKSPACE_ID,
      templateId: 'welcome-email',
      tags: [{ key: 'firstName', value: 'Ada' }]
    })
  }
)
// 202 Accepted - the send is queued, not delivered; check your workspace's
// delivery reports for the outcome.