Skip to main content
This is what an order webhook from your own system calls when it knows exactly which sequence it wants. The variables ride along with the enrolment, so a message three days later can still say the order number — the console has no idea what that is, which is the whole reason the field exists.
Prefer Report an event unless you have a reason not to. This endpoint puts a sequence’s id in your code. Rebuild the sequence and this call stops working; change which follow-up runs and somebody has to deploy.Use this one when the choice genuinely belongs to your system — a plan-specific onboarding, say, where your backend already knows which of five journeys applies.

​
Path

​
string
required
The sequence’s id, from its page in the console.

​
Body

​
string
required
The number to enrol. E.164, with or without the +.They must already be a contact. This does not create one — see the response below.
​
object
Values the sequence’s messages can use, as names to strings.At most 20, each name up to 60 characters and each value up to 300. Over any of those is refused rather than trimmed, because a shortened name would leave a template reading a blank that no longer exists.

​
Response

enrolled: false is a 200, not an error. Four things produce it — they are already in this sequence, the number is not a contact, they have opted out, or the sequence has no first message yet — and none of them is a failure of your request.A 4xx here would have a webhook retrying all four for ever, which is the one thing that turns “already enrolled” from a shrug into an incident.

​
Errors