Send an eForm

An eForm is one sent copy of a template. You do not design the form in the API. The practice designs templates in OnboardMe. You choose a template, choose who receives it, and then track submission with eform.submitted. Sending needs canWrite: true and enough subscription or wallet balance to send. A read-only credential can list templates and cannot send.

1. List templates

GET /api/v1/eforms/templates returns the templates this practice can send, including industry defaults and the practice’s own.

pageNumber starts at 1. pageSize defaults to 50 and caps at 100.
Inactive templates are omitted unless includeInactive=true.
The id you send is formTemplateId. On the send call that field is named templateId.

Cache the list and refresh it when a send says the template does not exist. Practices archive templates.

2. Choose the recipient

POST /api/v1/eforms/send has two recipient shapes. Stored client. Pass entityKey from Sync clients. Name, email, and mobile come from the client. Override any of recipientName, recipientEmail, or recipientMobile for this send only. The stored client is not updated. Someone not on file. Omit entityKey. recipientName and recipientEmail are required. recipientMobile is optional. The form is not tied to an entity.

{
  "templateId": 1842,
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "mute": false
}

{
  "templateId": 1842,
  "recipientName": "Jordan Lee",
  "recipientEmail": "[email protected]",
  "recipientMobile": "+61 412 000 111",
  "mute": true
}

3. Read the response before you assume the email went

A successful body includes formKey, accessUrl, emailSent, and sent.

Field	Meaning
`formKey`	The sent form. Store it. This is how you correlate the webhook.
`accessUrl`	Where the recipient completes the form.
`sent`	`true` when the form is in the sent state. `false` when OnboardMe kept it as a draft because the send step failed.
`emailSent`	`true` when the invitation email was handed off.

mute: true does not email. The form is still marked sent, and accessUrl is the same client link the email would have used. Put that URL in your own email, SMS, or portal. Do not build a different link. If sent is false, do not tell the recipient the form is waiting. Open accessUrl (a portal editor URL in that case), fix the problem, and send again from the product or with a new API call. Insufficient subscription or wallet returns an error and does not leave a half-sent form you should retry blindly. Top up, then send again.

4. Know when it is submitted

Do not poll for completion. Subscribe to eform.submitted with Webhooks. The delivery includes the form name, recipient, and a review link. Verify X-Om-Signature and dedupe on X-Om-Event-Id. The building-block shape of a sent form is The eForm.

Send eForm reference

Request fields, mute behaviour, and the template list.

Core Concepts

Guides

1. List templates

2. Choose the recipient

3. Read the response before you assume the email went

4. Know when it is submitted

Send eForm reference

​1. List templates

​2. Choose the recipient

​3. Read the response before you assume the email went

​4. Know when it is submitted

Send eForm reference

1. List templates

2. Choose the recipient

3. Read the response before you assume the email went

4. Know when it is submitted