tk_partner_ key that covers every application, and an application per merchant addressed by the partner’s own id for it, the external_id. The merchant does not need to know Tawked exists until the day it wants WhatsApp, and then the partner hands the application over.
Applications
Provision one per merchant, keep its brand and verify settings current, switch it off and on, read usage.
Sending for an application
The
application field on every Verify and WhatsApp call, and what blocks a send.Application owners
Hand an application to the merchant so they connect their own WhatsApp number and run the inbox.
Events
Every event, which ones reach your webhook, and the feed to poll or catch up from.
Partner webhooks
The envelope, the signature, the retries, and the delivery log by API.
Who holds what
The lifecycle of an application
Getting started
1
Get a partner account
Partner accounts are opened by Tawked, not by signup. Write to support@tawked.com with what you run and how many merchants you expect. You sign in with your phone like any account and land in the partner console.
2
Create your key
Partner console, Integration, API key. The key is shown once; you can give it an expiry and an IP allowlist, and it is always full scope. Rotating issues the new key and revokes the old one in the same step, with no overlap window, so rotate from where you can update the secret at once.
3
Set your webhook
Integration, Webhook: an HTTPS URL, a signing secret revealed on demand and rotatable, and a low-balance threshold in halalas. See Partner webhooks.
4
Provision an application per merchant
POST /v1/partner/applications with your external_id, the Arabic and English brand names and the website. The answer says whether the application is active already or in review; service.approved or service.rejected tells your backend the outcome.5
Send on the application's behalf
Every Verify and WhatsApp call takes
application with your external_id. See Sending for an application.6
Hand it over when it needs WhatsApp
POST /v1/partner/applications/{external_id}/owner invites the merchant by phone. See Application owners.Start with the profile
GET /v1/partner/profile says who the key belongs to and what to expect: the approval mode (whether a provision waits for a human, and whose decision it is), the price of a code and of a WhatsApp message for your account, the balance, the rate limit, the owner-invitation caps, the key in use with its expiry and allowlist, and whether a webhook is configured. An agent reads it before its first provision.
The shape of the partner API
The full reference, each page with a playground: Get the profile, Preview the screening, Provision an application, Provision in bulk, List applications, Get an application, Get the history, Update the brand, Upload the logo, Remove the logo, Update the verify settings, Suspend, Resume, Unpause, Archive, Restore, Get the owner, Invite the owner, Revoke the owner, Get usage, List verifications, List WhatsApp messages, Get the event feed, Get the webhook, Update the webhook, List deliveries, Retry a delivery, Get the WhatsApp state, List the templates, Get a template, Create a template, Update a template, Delete a template, List the team, Add a team member, Remove a team member.
To try the flow before anything is approved, create a sandbox key (
tk_partner_test_) under Integration: provision a test merchant with the live key, then send with the sandbox key to your own verified phone, stamped and capped. See The sandbox key.