REST API · messages

POST https://api.pulpo.chat/v1/messages
Token: TU_CLAVE_DE_API
Content-Type: application/json

{
  "phone": "+14155550187",
  "message": "Your order is ready for pickup at the store."
}

Message created · 201

HTTP/1.1 201 Created
{"id":"ID_MENSAJE_DE_EJEMPLO"}

WhatsApp API for your system

Your system notifies.Your team keeps the conversation going.

When an order is ready, your system can create the message. Your team continues the conversation in Pulpo.

Start free See it in action

Fictitious details. Use an authorized account, an operational number and the applicable sending conditions.

Request, event and template.

Examples of documented operations. Consult the full schema and test with your account before integrating.

The order is ready

Create a message

Notify that the order can be picked up.

Your server uses the Token header and the request body. The recipient and text in this example are fictitious.

PulpoChatREST API · messages

Example request

POST https://api.pulpo.chat/v1/messages
Token: TU_CLAVE_DE_API
Content-Type: application/json

{
  "phone": "+14155550187",
  "message": "Your order is ready for pickup at the store."
}

Message created · 201

HTTP/1.1 201 Created
{"id":"ID_MENSAJE_DE_EJEMPLO"}

The 201 confirms message creation. Check its progress before assuming it reached the recipient.

Check access to the number, the recipient's permission and sending rules. If you have several numbers, review the device field in the documentation.

A new conversation arrives

Receive an event

Inform your system of an incoming message.

You configure your webhook URL and the events you need. This fragment shows fields from an event; it is not the full schema.

PulpoChatWebhook · incoming message

POST to your server · example

POST https://tu-servidor.example/webhooks/pulpo
Content-Type: application/json
X-Idempotency-Key: ID_EVENTO_DE_EJEMPLO

{
  "id": "ID_MENSAJE_DE_EJEMPLO",
  "object": "message",
  "event": "message:in:new"
}

Your server's response · example

HTTP/1.1 200 OK

Your server processes the event and decides what to do with it. Prepare retry handling to avoid processing the same event several times.

Use HTTPS in production and validate the full schema. Receiving a webhook does not send a WhatsApp reply on its own.

You prepare a proactive notification

Look up templates

Find an approved template for the notification.

Look up the account's templates and review the name, language and content before preparing to send.

PulpoChatREST API · templates

Example query

GET https://api.pulpo.chat/v1/waba/templates?status=approved
Token: TU_CLAVE_DE_API

Response fragment · example

{"data":[{"name":"PLANTILLA_DE_EJEMPLO",
"status":"approved","language":"es"}],
"total":1,"page":0,"size":1}

The query returns templates you can review. To send, follow the format and requirements in the documentation.

Approved templates are required when WhatsApp's rules demand them. This query does not create or send a message.

From example to integration.

Test the request, prepare the event receiver or consult the template schema.

Create the message from your system

Review the message schema and test the request with a prepared account in the API tester.

Open the API tester

Receive what happens on WhatsApp

Prepare your HTTPS receiver, select events and handle retries before using it in production.

Consult the webhook guide

Review the account's templates

Look up approved templates and sending formats with their language and variables.

Open the API documentation

Would you prefer a visual journey?

Flows brings together steps and connections you need to configure and test. The MCP server lets you request tasks from an authorized client such as ChatGPT or Claude.

See Flows See the MCP server

A key. A number. A test.

Keep credentials on your server and check the operation before connecting it to real work.

Create and protect your key
Use an authorized key for your account. Store it on the server and check its access before sharing an integration.
Check the number
Verify that the number is operational and your account has access and capacity for the operation.
Test requests and events
Consult the schema, run a test request and validate the response. If you use webhooks, prepare the receiver and retry handling.

Before you start

An authorized account and an operational number.
Credentials protected on your server; examples do not include a real key.
The recipient's permission and approved templates when sending requires them.
An HTTPS receiver and retry handling if you use webhooks.

Start free See plans and terms

Before connecting your system.

Does a 201 mean the message arrived?

The 201 confirms that the message was created. Consult its status and available events to track its progress; do not use it as proof of delivery or reading.

Can I put my key on the web page?

Keep the key on your server. Avoid exposing it in the browser, public repositories or shared examples.

When do I need an approved template?

When WhatsApp's rules require one, such as proactive messages outside the service window. Review the requirements and sending format in the documentation.

Prepare the notification your system needs.

Start free

Create your account, check access and consult the documentation to test the operation.