Skip to content

Integrations

Zapier

The OmniMessage integration for Zapier: send messages and manage contacts from any Zap, and start Zaps from inbound messages and delivery receipts.

Status#

Connect#

  1. Create an API key in the console. Create integration key opens the dialog with the integration preset selected. Start with a test key (om_test_): nothing is delivered and nothing is billed.
  2. In Zapier, add an OmniMessage connection and paste the key. Zapier tests it with GET /v1/me and labels the connection with the account name and mode.

Triggers, actions and searches#

TypeNameWhat it does
TriggerNew Inbound MessageA message received on one of your channels. Optional channel filter.
TriggerMessage Status ChangedAn outbound message was sent, delivered, read or failed. Statuses are selectable; the default is delivered and failed.
ActionSend MessageText, media or WhatsApp template through a channel, with reference, reply-to, metadata and a deduplication key.
ActionCreate or Update ContactBy phone number, with tags and consent.
SearchFind MessageBy ID, or the newest by reference or recipient.
SearchFind ChannelBy ID, or by name, type or identifier.

The Channel and Template fields are dropdowns filled from your account.

How it works#

  • Turning on a Zap with a trigger creates a webhook endpoint for the Zap’s hook URL; turning it off deletes it. Each delivery is verified (HMAC-SHA256 over the raw body, five-minute tolerance) before it reaches the Zap.
  • While you build the Zap, recent messages are loaded as samples, with the same fields the live trigger produces.
  • Errors show the API’s message and param, with a hint for common codes. A 401 asks you to reconnect; a 429 is reported to Zapier as throttled, with the Retry-After delay.

Limits#

  • An account can have 10 webhook endpoints per mode, and every Zap with one of the triggers uses one.
  • Test keys never receive inbound messages, so New Inbound Message can only be tried with a live key.
  • Send Message covers text, media and templates with body variables, one header variable or media, and one URL button variable. For buttons, lists and locations, call POST /v1/messages with Webhooks by Zapier.

    Loading