The event is triggered when the call is received by the user.

postWebhookcall.received

Payload

idstring required

Unique identifier for the event - lower case ULID format. https://github.com/ulid/spec

timestampnumber required

Unix timestamp (ms) for when the event was created.

sessionstring required
metadataobject

Metadata for the session.

engine'WEBJS' | 'WPP' | 'NOWEB' | 'GOWS' required
eventobject required

The event is triggered when the call is received by the user.

Example payload

{
  "id": "evt_01aaaaaaaaaaaaaaaaaaaaaaaa",
  "timestamp": 1634567890123,
  "session": "default",
  "metadata": {
    "user.id": "123",
    "user.email": "email@example.com"
  },
  "engine": "WEBJS",
  "payload": {
    "id": "ABCDEFGABCDEFGABCDEFGABCDEFG",
    "from": "11111111111@c.us"
  },
  "me": {
    "id": "11111111111@c.us",
    "lid": "123123@lid",
    "jid": "123123:123@s.whatsapp.net",
    "reachoutTimelock": {
      "enforcementType": "RESTRICT_ALL_COMPANIONS",
      "isActive": true,
      "timeEnforcementEnds": 1784477333
    },
    "messageCapping": {
      "cappingStatus": "FIRST_WARNING",
      "totalQuota": 1000,
      "usedQuota": 640,
      "cycleStart": 1782874800,
      "cycleEnd": 1785553199,
      "mvStatus": "NOT_ELIGIBLE",
      "oteStatus": "NOT_ELIGIBLE"
    }
  },
  "environment": {
    "version": "YYYY.MM.BUILD",
    "engine": "WEBJS",
    "tier": "PLUS",
    "browser": "/usr/path/to/bin/google-chrome",
    "platform": "linux/x86"
  }
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.