Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.periskope.app/llms.txt

Use this file to discover all available pages before exploring further.

  {
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "notification_id": "true_120363371308389685@g.us_fa3c48a78cc64e139e5737f7057235ea_918527184400@c.us_remove",
      "chat_id": "120363371308389685@g.us",
      "author": "918527184400@c.us",
      "body": null,
      "id": {
          "id": "fa3c48a78cc64e139e5737f7057235ea",
          "fromMe": true,
          "remote": "120363371308389685@g.us",
          "serialized": "true_120363371308389685@g.us_fa3c48a78cc64e139e5737f7057235ea_918527184400@c.us_remove"
      },
      "recipientids": [
          "919537851844@c.us"
      ],
      "type": "remove",
      "timestamp": "2025-01-11T11:52:27.231+00:00",
      "org_phone": "918527184400@c.us",
      "unique_id": "fa3c48a78cc64e139e5737f7057235ea",
      "metadata": null
  }
Refer Chat Notification object to find more details about chat notification object. 
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

client.on('chat.notification.created', (data) => {
  console.log(data);
});

​
Event structure 📦

You’ll be receiving the data in the following format: 
{
  "event": "<event-type>",
  "data": "<event-data>", // complete data object as mentioned in Objects section
  "org_id": "<your-organisation-id>",
  "timestamp": "<timestamp>" // timestamp of the event creation
}