Pulvify API
Manage WhatsApp sessions via instances: send messages, manage groups, communities, contacts, channels, and webhooks through a simple REST API.
69
8
JSON
Authentication
Every call goes to https://api.pulvify.com. The /instances routes use the account token; the /{instance}/... routes use the api-key of the instance that receives the operation.
Account token
Send it in the account-token header. Generate it under Settings > API in the panel; it creates, lists and deletes instances within your plan limit.
Instance token
Send it in the api-key header. Each WhatsApp instance has its own token, available on the instance page in the panel.
Collection variables
| {{base_url}} | API gateway URL (https://api.pulvify.com). |
| {{instance}} | Slug of the instance (session) that will receive the operation. |
| {{account_token}} | Your account token (account-token header), used on the /instances routes. |
| {{instance_token}} | Instance token (api-key header). |
| {{group_id}} | Group JID, in the format GROUP_ID@g.us. |
| {{community_id}} | Community JID, in the format COMMUNITY_ID@g.us. |
| {{webhook_id}} | Identifier of the webhook created on the instance. |
| {{jid}} | Channel/newsletter JID, in the format CHANNEL_ID@newsletter. |
Webhook events
When creating a webhook, choose which event categories you want to receive. Use ["*"] to receive everything. The payload arrives in the format {event, eventId, sessionId, data}.
| connection | QR Code, pairing, connection, and disconnection. |
| history | History received from WhatsApp (not retroactive). |
| messages | New messages from individual and group conversations. |
| messages_update | Receipts, edits, deletions, reactions, and votes. |
| newsletter_messages | New posts from WhatsApp channels. |
| call | Call offer, accept, reject, and termination. |
| contacts | Address book, names, description, identity, and contact photos. |
| presence | Presence, typing, and recording (depends on presence subscription). |
| groups | Group participants, permissions, metadata, and photos. |
| labels | Label creation, editing, and removal. |
| chats | Archive, pin, mute, mark read, clear, and remove conversations. |
| chat_labels | Label association and removal in conversations. |
| blocks | Block list and changes. |
Headers
Request body