Skip to content

Integrations

Integrations

Use OmniMessage from automation platforms, WordPress and WooCommerce, Shopify, Node.js, AI agents and Postman, or report events from your own systems.

Two ways to integrate#

  • Tools that call the API with your key: n8n, Zapier, Make, the Node.js SDK, the MCP server and Postman. They send messages, read their status and start workflows from webhooks, exactly like your own code would.
  • Sources that report events: WooCommerce, Shopify, the WordPress plugin and your own systems send what happened, such as an order being paid, as automation events. Which message follows is designed in the console, not in the plugin.

Directory#

The same directory is in the console under Integrations, where each entry has its setup steps.

IntegrationCategoryStatusHow it is installedSetup
n8nAutomation platformsAvailablePackage or plugin you installPaste an API key
ZapierAutomation platformsBetaMarketplace listing pendingPaste an API key
MakeAutomation platformsBetaMarketplace listing pendingPaste an API key
WooCommerceE-commerceAvailableThe platform’s own webhooks, no pluginCreate a source in the console
WordPressCMSAvailablePackage or plugin you installPaste an API key
ShopifyE-commerceBetaThe platform’s own webhooks, no pluginCreate a source in the console
Node.js SDKDeveloper toolsAvailablePackage or plugin you installPaste an API key
PostmanDeveloper toolsAvailablePackage or plugin you installPaste an API key
MCP serverDeveloper toolsAvailablePackage or plugin you installPaste an API key
Your own integrationDeveloper toolsAvailablePackage or plugin you installCreate a source in the console

Planned, not installable yet: Salla, Zid, ikas, HubSpot, Pipedream, Activepieces, Albato, Power Automate, PHP SDK, Python SDK, GitHub Action. In the console directory, Notify me records your interest and we email you when one can be installed. If the tool you need is not listed, contact us.

The integration key#

Tools that ask for an OmniMessage API key should get a key of their own, not a full-access key. In the console, API keys › Create integration key preselects the integration preset: messages:write, messages:read, channels:read, webhooks:read, webhooks:write, contacts:read, contacts:write, integrations:read, integrations:write, events:write. It has no billing, campaign or event-reading scopes.

  • The key decides the mode: a test key works only with sandbox channels (ch_test_<type>) and never reaches real recipients.
  • A tool that also reads the balance, launches campaigns or reads event receipts needs a key with those scopes added. The scopes table lists what each scope allows.
  • One key per tool or site lets you revoke one without touching the others.

Postman#

A Postman collection with one request per API operation and three environments (test, live, local) is generated from the OpenAPI document. It adds bearer authentication from {{api_key}}, a fresh Idempotency-Key on every POST, the sandbox channel ch_test_whatsapp as {{channel_id}}, and tests that capture IDs for the following requests.

  1. Import the collection and the test environment.
  2. Set api_key to a test key.
  3. Run Account › Retrieve the current account, then Messages › Send a message.

The collection is not published on the Postman API Network yet. Until it is, contact us for the collection files, or import the OpenAPI document into Postman directly, which always describes the current API:

Download the OpenAPI document
curl -o omnimessage-openapi.json https://omnimessage.co/docs/openapi.json

Build your own#

  • To send messages from a tool that is not listed, call the API directly or use the Node.js SDK. Libraries has copy-and-paste clients for other languages.
  • To trigger messages from a system you run, create a source of type "Your own integration" in the console and push automation events with its source key.
  • To react to deliveries and inbound messages, subscribe a webhook endpoint.

    Loading