Documo integration

What it does

Documo (mFax) is a HIPAA-compliant cloud fax platform. Connect it to send faxes on behalf of your clients, pull fax history and delivery results into reporting, keep contacts and tags in step with your CRM, and start a workflow the moment a fax arrives or a transmission completes. The integration also reaches Documo's mDrive storage and its document-processing features, so a received fax can be classified, OCR'd and filed without anyone opening the dashboard.

Connect a Documo account

1. Sign in to Documo and open Settings, then API, then API Keys.
2. Create a key. Choose the admin access level if your workflows touch fax numbers, users or FaxBridge devices, because Documo refuses those endpoints to a base-level key.
3. Copy the key. Documo shows it only once.
4. In TaskJuice, add the key on the Documo node in your workflow.

Documo issues a single opaque key rather than an ID and secret pair. Paste the whole value into the API key field and nothing else.

Two account-level limits are worth checking before you build. Sending faxes through the API is gated on your Documo plan, so a trial or entry-level account can return "API access required" from Send Fax while reads keep working. Fax number, user and FaxBridge endpoints need that admin-level key.

Triggers

Documo delivers one event per HTTP POST. Each trigger below corresponds to one Documo webhook event.

• documo/fax-received — an inbound fax has finished arriving on a connected number.
• documo/fax-inbound-started — an inbound fax has begun arriving, before the pages are complete.
• documo/fax-inbound-failed — an inbound fax failed to complete.
• documo/fax-sent — an outbound fax completed successfully. This is the delivery confirmation.
• documo/fax-send-failed — an outbound fax failed after its final attempt.
• documo/fax-queued — an outbound fax was accepted and queued, before transmission.
• documo/number-added — a fax number was provisioned onto the account.
• documo/number-released — a fax number was released back to the carrier.
• documo/number-ported — a port-in completed and the number went live.
• documo/user-created — a user was created on the account.
• documo/user-deleted — a user was deleted from the account.
• documo/ocr-completed — OCR finished on a workspace document, carrying the extracted text.
• documo/ocr-pdf-ready — a searchable OCR PDF is ready to download.
• documo/document-type-assigned — a workspace document was classified into a document type.
• documo/document-fields-extracted — document field values were extracted and assigned.
• documo/split-detection-completed — split detection finished analysing a packet.
• documo/fax-inbound-page — one page of an inbound fax arrived. Fires once per page.
• documo/fax-inbound-succeeded — an inbound fax arrived successfully.
• documo/fax-outbound-succeeded — an outbound fax was delivered successfully.
• documo/session-started — a user signed in to Documo. Carries userId, accountId, sessionId and deviceId.
• documo/session-ended — a Documo session ended. Carries userId, accountId, deviceId and isUserInitiatedLogout, which is true for a deliberate sign-out and false when the session expired or was ended for the user.
• documo/secure-message-sent — an outbound Direct Secure Message was delivered.
• documo/secure-message-send-failed — an outbound Direct Secure Message failed.
• documo/secure-message-received — an inbound Direct Secure Message arrived.

Every fax trigger carries the same flat record, including messageId, status, direction, pagesCount, resultCode and resultInfo. Pass messageId to Get Fax or Download Fax to work with the document itself.

Choosing between .succeeded and the completion triggers

Documo emits both a completion event and a success-only event for inbound and outbound faxes. Fax Sent and New Fax Received fire whether the fax succeeded or failed — check status before acting. Fax Sent Successfully and Inbound Fax Succeeded fire only on success, so prefer those when a failure must not enter the workflow at all.

Triggers with no declared fields

The three secure-messaging triggers list no output fields. Documo publishes no payload reference for them and Direct Secure Messaging is a separate product, so no delivery could be observed to confirm a shape — and TaskJuice does not declare field names it has not seen on the wire. The triggers still fire and the full payload is still available; map from it directly once you have seen a delivery.

Actions

Sending faxes

• documo/send-fax — send a fax to one number, from attachment URLs, mDrive file IDs, or a cover page alone.
• documo/send-multiple-faxes — send the same document to several numbers or contacts at once.
• documo/resend-fax — resend a previous fax, optionally to a different number.
• documo/preview-fax — render a proof without sending it.
• documo/fax-blast — broadcast to a recipient list supplied as a spreadsheet.
• documo/cancel-fax — cancel a fax that is still queued, scheduled or transmitting.

Working with sent and received faxes

• documo/list-faxes — list fax history, filtered by direction and status.
• documo/get-fax — retrieve one fax, including status, page counts and result code.
• documo/download-fax — download the rendered document as a PDF or TIFF.
• documo/split-fax-download — split one fax into several named documents by page range.
• documo/update-fax — archive or unarchive a fax.
• documo/delete-fax — permanently delete a fax and its stored document.
• documo/list-cover-pages — list the cover pages available to the account.

Fax numbers

• documo/list-numbers — list the numbers provisioned on the account.
• documo/validate-number — check a number is a reachable fax destination before sending.
• documo/add-user-to-number — grant a user access to a number.
• documo/remove-user-from-number — revoke a user's access to a number.
• documo/update-number-settings — change a number's storage configuration or managing account.
• documo/release-number — release a number back to the carrier.

Contacts, tags and custom fields

• documo/list-contacts — list stored contacts and organizations.
• documo/create-contact — add a contact or organization.
• documo/update-contact — update a contact's details.
• documo/delete-contact — delete one contact.
• documo/bulk-delete-contacts — delete several contacts in one call. Does not currently work; see Known limitations.
• documo/list-tags — list the tags defined on the account.
• documo/create-tag — create a tag for routing and reporting.
• documo/delete-tag — delete a tag and remove it from every fax carrying it.
• documo/assign-tag-to-fax — apply a tag to a fax.
• documo/unassign-tag-from-fax — remove a tag from a fax.
• documo/list-custom-fields — list custom fields defined for faxes, accounts or users.
• documo/create-custom-field — define a new custom field.
• documo/archive-custom-field — archive or unarchive a custom field.
• documo/delete-custom-field — delete a custom field and its recorded values.

Users and accounts

• documo/get-current-user — retrieve the connected user and account, useful as a health check.
• documo/list-users — list the users on the account.
• documo/get-user — retrieve one user.
• documo/create-user — create a user and choose the products they can reach.
• documo/update-user — update a user's profile and fax notification preferences.
• documo/deactivate-user — revoke a user's access without deleting them.
• documo/reactivate-user — restore access for a deactivated user.
• documo/delete-user — permanently delete a user.
• documo/list-accounts — list sub-accounts beneath the connected account.
• documo/get-account — retrieve one account's settings and enabled products.
• documo/create-account — create a sub-account for a new client.
• documo/update-account — update a sub-account's name, timezone or feature flags.
• documo/delete-account — permanently delete a sub-account and everything in it.

Reporting, devices and storage

• documo/summary-report — aggregate fax volume and page counts for a date range.
• documo/detailed-report — per-fax detail for a date range.
• documo/list-faxbridges — list registered FaxBridge devices.
• documo/get-faxbridge — retrieve one FaxBridge device.
• documo/update-faxbridge — rename a device or change the number it is bound to.
• documo/create-folder — create an mDrive folder.
• documo/get-folder — retrieve an mDrive folder's metadata and contents.
• documo/upload-file — upload a file to mDrive and reuse its ID on a later send.

Known limitations

Webhook subscriptions are created by hand. Documo's registration API takes its event set in a shape TaskJuice cannot yet generate automatically, so you create the webhook once in the Documo dashboard under Toolbox, then Webhooks, pointing it at the URL the trigger gives you and selecting the events you want.

Deliveries are protected with HTTP Basic, not a signature. Documo does not sign webhook bodies. When you create the webhook, turn on Basic Auth and set a username and password, then paste the resulting Authorization header value into the trigger's inbound authentication field exactly as Documo will send it, including the Basic prefix.

Sending faxes needs a plan with API access. Reads can succeed while Send Fax returns "API access required" on entry-level and trial accounts.

Some endpoints need an admin key. Fax numbers, users, FaxBridge devices and sub-account management reject a base-level key with a 403, "API access required". Reading your own account with Get Account still works — it is only creating, updating and deleting sub-accounts that is gated.

Bulk Delete Contacts does not work, and reports success. Documo's bulk endpoint answers 200 with empty successIds and errorIds and deletes nothing — confirmed against every request shape including the one its own documentation specifies, and confirmed again with a deliberately invalid ID, which it neither rejected nor echoed. Use Delete Contact per contact until Documo fixes it.

Delete a custom field only after archiving it. Documo refuses to delete a field that is still active. Run Archive Custom Field first.

Rate limits. 60 calls per minute per key overall, 180 per minute for sending faxes, and 4 per minute for the detailed report. Schedule reporting rather than calling it per record.

Document signing events are not available. Documo's webhook event list is a closed set of 24 identifiers and contains no signing events at all, on any account. Document Completed and Document Failed cannot be subscribed to.

Failed deliveries retry seven times, then stop. Documo re-sends after 5s, 25s, 2m, 10m, 52m, 4h and 22h, treating any 2xx as success. After the seventh attempt it emails the account instead. Its deliveries originate from 35.225.187.84 if you need to allow-list them.