Send Verification Token
messagebird.create_verify
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Send a one-time token to a phone number or email address and return the verification object whose id the check step needs.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- MessageBird
- Secret shape
- the access key, or {"access_key": "…"}
- Config it needs
- originator, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
11 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
recipient The phone number, or the email address when verify_type is email. | string | Yes | — | — | +31612345678 |
verify_type How to deliver the token: sms, a flash message, a spoken tts call, or email. | string | No | — | one of "sms", "flash", "tts", "email" | — |
originator The sender shown to the recipient. Overrides the connection's default originator. | string | No | — | — | — |
template The message body; it must contain %token, which MessageBird replaces with the generated code. | string | No | — | — | Your Acme code is %token |
subject Subject line for the email, used only when verify_type is email. | string | Conditional | — | only with verify_type | — |
datacoding Character set for the message: plain, unicode or auto. | string | No | — | one of "plain", "unicode", "auto" | — |
timeout How many seconds the token stays valid. | number | No | — | 30–172801 | — |
token_length How many characters the generated token has. | number | No | — | 6–10 | — |
max_attempts How many times the recipient may submit a wrong token. | number | No | — | 1–10 | — |
voice Which text-to-speech voice reads the token on a tts call. | string | No | — | one of "male", "female" | — |
language Text-to-speech language tag for a tts call, such as en-gb. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"recipient": "+31612345678",
"template": "Your Acme code is %token"
}Output
One shape.
result
The provider's response object, as returned.
Extra keys beyond the ones listed can appear.
{}See Send Verification Token run in a workflow.
In a technical demo we add the MessageBird connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.