Create onboarding link
Create a link you can send to a customer so they can connect their WhatsApp number or Instagram account. Links stay listed and copyable.
Authorizations
Authorization: Bearer hmok_... API key or a dashboard session token
Body
whatsapp, instagram 80Existing customer (ws_) the connect lands in. Omit to create a new customer on connect.
801202048256Where we notify you when the customer's connect finishes. We POST a
signed channel.connected event on success or channel.connect_failed
on failure — never mixed into your message destination webhook.
Where we send the customer's browser after a successful connect. We
append status=completed, phone_number_id, display_phone_number,
and externalId when set.
Where we send the customer's browser after a failed connect. We append
status=failed, externalId when set, and reason, one of:
customer_cancelled, permission_denied, already_connected,
no_number_available, link_inactive, temporary_failure,
service_error.
120Response
Link created
Signs connectedNotificationUrl deliveries. Verify the
X-HookMyApp-Signature-256 header against this secret (HMAC-SHA256
over the raw request body). Minted on every new link — null only on
links created before signing secrets existed. To get one, regenerate
the link (note: regenerating also rotates the connect URL).