Zapier

Reference implementation of a Zapier integration with Efimis. It uses the REST API for searches and actions, and webhooks to start Zaps when events occur in Efimis.

Self-managed integration

This is not an official Efimis app in the Zapier App Directory. Deploy the source to your own Zapier developer account and maintain it as a private integration. You can invite your firm’s users or testers to that integration through Zapier.

Capabilities

• Start a Zap when an Efimis webhook event is delivered.
• Find clients and matters, or get one by ID.
• Create and update matters.
• Populate Zapier fields from live Efimis divisions, matter types, clients, matters, and billing contacts.

The webhook trigger accepts supported Efimis event types, including events for clients, matters, invoices, and work items. Use fully qualified Efimis event names, for example Efimis.Mk2.Accounting.V1.MatterUpdated. The integration translates these to the current API subscription identifiers.

Source code

github.com/efimis-dev/efimis-zapier-integration

The repository includes a Dev Container, automated tests, Zapier validation, and anonymised static samples. Its README contains the complete deployment and maintenance instructions.

Before you start

You need:

• An Efimis sandbox tenant and integration credentials.
• A Zapier developer account.
• Git and either the repository’s Dev Container or Node.js 22 with zapier-platform-cli 19.1.0.

Your Efimis integration credentials include a client ID, client secret, API scope, regional API URL, and authentication URL. Contact connections@efimis.com if you need sandbox access or credentials.

Use sandbox credentials while deploying and testing the integration.

Deploy the integration

Clone the repository, open its src directory, and install the locked dependencies:

git clone https://github.com/efimis-dev/efimis-zapier-integration.git
cd efimis-zapier-integration/src
npm ci

Log in to Zapier, then register a new private integration or link an existing one:

zapier-platform login
zapier-platform register "Efimis"

Use zapier-platform link instead of register when the integration already exists. Both commands create src/.zapierapprc; never commit that file.

Push the first private version:

npm run check
zapier-platform push

Zapier versions are immutable. Increment the package version before each later production-shaped push, then rerun the checks:

npm version patch --no-git-tag-version
npm run check
zapier-platform push

Configure the version

Set these environment variables under Build → Advanced for the deployed version in the Zapier Developer Platform:

Variable	Value
API_URL	Regional Efimis API origin, such as https://api.au.efimis.com or https://api.uk.efimis.com. Do not include a firm alias or /api/v1.
AUTH_URL	Complete OAuth token endpoint supplied with the integration credentials.
SCOPES	OAuth scope supplied with the integration credentials, typically ending in /.default.
CLIENT_ID	Efimis integration client ID.
CLIENT_SECRET	Efimis integration client secret.

Environment variables are version-specific. Confirm them after each push and never commit credentials or .env files.

The firm alias is connection-specific, not an environment variable. Each user enters their firm_alias when they connect Efimis in Zapier.

Configure a webhook trigger

Each Webhook Event trigger requires:

• A comma-separated list of fully qualified Efimis event names.
• A newly generated random GUID as its webhook secret.

Generate a different webhook secret for every Zap. Do not reuse the Efimis client secret, an example value, or another Zap’s webhook secret.

Each active Zap creates one Efimis webhook subscription. A tenant can have at most 5 webhook subscriptions, so disable unused Zaps before creating replacements.

Efimis delivers webhooks at least once. The integration verifies the HMAC-SHA256 signature, timestamp, tenant alias, and request ID, then derives a stable event ID from the event payload so Zapier can deduplicate retries. Do not use the delivery request ID as an idempotency key because it changes on each delivery attempt.

The trigger exposes the complete event body as raw_payload. It can contain sensitive client, matter, invoice, or work-item data. Map it only to steps authorised to receive that information, and make sure access to Zapier task history and its retention follow your firm’s data-handling policy.

Test the deployment

After configuring the version:

1. Connect an Efimis sandbox account in Zapier.
2. Test authentication, searches, actions, and dynamic dropdowns in the Zap editor.
3. Turn on a test Zap and confirm that Efimis creates its webhook subscription.
4. Trigger a sandbox event and confirm that the Zap receives it.
5. Turn off the Zap and confirm that its webhook subscription is removed.

Keep the deployed version private. Zapier promotion is required only when a maintainer intentionally wants to pursue an official App Directory listing.