AI agents

Integrate with an AI agent

If Claude Code, Codex, Cursor, or another coding agent is writing your integration, give it the CommuniQueue skill first. It is the same knowledge as these docs, packaged the way agents read it.

What the skill is

Three Markdown files. An agent loads the first one when a task mentions sending email or webhooks through CommuniQueue and reads the other two on demand. They are published from the same repository as the API, so when the API changes the skill changes with it.

• SKILL.mdSetup order, the send call, the errors worth branching on, template syntax, and the mistakes agents make most.
• reference.mdRequest and response shapes, every error code, rate limits, and the webhook signature check.
• examples.mdA send wrapper in Node and one in C#, with retry rules and string-typed tags.

Install it

Skills are folders. Put the three files in a folder named integrating-communiqueue wherever your tool looks for skills, and the agent picks it up on its next session.

mkdir -p ~/.claude/skills/integrating-communiqueue && cd $_ \
  && curl -sSO https://communiqueue.com/skills/integrating-communiqueue/SKILL.md \
  && curl -sSO https://communiqueue.com/skills/integrating-communiqueue/reference.md \
  && curl -sSO https://communiqueue.com/skills/integrating-communiqueue/examples.md

mkdir -p .claude/skills/integrating-communiqueue && cd $_ \
  && curl -sSO https://communiqueue.com/skills/integrating-communiqueue/SKILL.md \
  && curl -sSO https://communiqueue.com/skills/integrating-communiqueue/reference.md \
  && curl -sSO https://communiqueue.com/skills/integrating-communiqueue/examples.md

Other tools that support the Agent Skills folder format take the same three files in their own skills directory. Check your tool's documentation for the path.

If your tool has no skill support

Any agent that can fetch a URL can use the skill. Paste this at the top of your prompt:

Before writing any CommuniQueue integration code, read
https://communiqueue.com/skills/integrating-communiqueue/SKILL.md
and follow it. It links to a reference and to example send wrappers.

What the agent still needs from you

The skill covers the API. Three things happen in the CommuniQueue app and need a person:

• Create the template and publish it. The agent needs its id, a GUID from the template's URL.
• Verify the sending domain or single sender. An unverified from address is refused with sender.not_verified.
• Create an API key and hand it over as a secret, never in the prompt or in source.

The Quickstart walks through all three.

llms.txt

https://communiqueue.com/llms.txt lists every docs page, the skill files, and the OpenAPI document in the form agents look for first. Point a tool at it when it asks where the documentation lives.