yanola/DocsOpen dashboard
Browse documentation

Tutorials

Tutorial: developer message integration

Create an API key, list Senders, send through @yanola/whatsapp, receive signed status events, and inspect logs.

DevelopersAdvancedAvailable

What this guide covers

  • This path connects Yanola credentials, SDK messaging, signed webhooks, and logs without exposing Meta provider credentials.
  • Prerequisites: Agent Project, connected Sender, server runtime, Test Mode API key, and public HTTPS webhook for live callbacks.
  • Result: A Test Mode request validates, a live request is accepted when eligible, signed events are verified, and records correlate by Yanola IDs.
  • Limit: Yanola API keys are server-side credentials. Accepted sends are asynchronous and do not guarantee final delivery.

What this is and when to use it

This path connects Yanola credentials, SDK messaging, signed webhooks, and logs without exposing Meta provider credentials.

When to use Tutorial: developer message integration
Use it whenExpected outcome
Your server application needs to send and monitor WhatsApp messages.A Test Mode request validates, a live request is accepted when eligible, signed events are verified, and records correlate by Yanola IDs.

Before you begin

  1. Agent Project, connected Sender, server runtime, Test Mode API key, and public HTTPS webhook for live callbacks.

Complete the task

  1. Follow the Developer Platform quickstart.
  2. Install @yanola/whatsapp and load YANOLA_API_KEY from a server environment.
  3. List Senders and select a Yanola Sender.
  4. Send in Test Mode and preserve the returned public message ID.
  5. Configure a webhook, verify Yanola signatures against raw bytes, and deduplicate events.
  6. Move to a Live key only after the production checklist.
  7. Inspect Messages, Events, Deliveries, and Usage.

Confirm it worked

  1. A Test Mode request validates, a live request is accepted when eligible, signed events are verified, and records correlate by Yanola IDs.

Common problems

Tutorial: developer message integration troubleshooting
SymptomWhat to check
Browser code contains an API keyMove the call to a trusted server immediately and rotate the key.
Webhook signature failsVerify against the exact raw request body before JSON parsing.

Current limitations

Yanola API keys are server-side credentials. Accepted sends are asynchronous and do not guarantee final delivery.

Where to go next

Related documentation

QuickstartInstall the SDK, create a Test Mode API key, select a Sender, and accept your first WhatsApp message request.Webhook signature verificationAuthenticate webhook requests against the raw request body before trusting their contents.Messages, events, and logsInspect public message state, normalized events, and webhook delivery summaries without exposing provider payloads.