Docs

Reference

friend.added — Saved to contacts

The account saved a person to its Telegram contacts (from the app or the phone).

View MarkdownThis page is generated from the source code on every release.

The account saved a person to its Telegram contacts (from the app or the phone).

Since web 1.7.0, worker —.

Name Value
Code friend.added
Group Telegram contacts
Status Subscribable
Scope needed to receive it messages.read
Tied to one account Yes
Only the connection that caused it receives it No
Filters that apply conversation_ids
Fields dropped in thin content mode peer.name, peer.username
Fields written by outside people (untrusted) peer.name

JSON Schema

https://tlg.builera.app/schemas/events/friend.added/2.json

Sample payload (exactly what webhooks.test sends)

{
  "specversion": "1.0",
  "id": "evt_01JDOCSSAMPLE",
  "source": "https://tlg.builera.app/ws/07c2e5e1-c42f-4212-851b-c55b6dd7989d",
  "type": "friend.added",
  "time": "2026-10-21T13:45:00.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://tlg.builera.app/schemas/events/friend.added/2.json",
  "platform": "telegram",
  "workspaceid": "07c2e5e1-c42f-4212-851b-c55b6dd7989d",
  "accountid": "1a7d2c40-5b1e-4e7a-9d3f-6c2b8e1f0a11",
  "seq": "000000000000000",
  "schemaversion": "2",
  "correlationid": null,
  "causationid": null,
  "test": true,
  "replay": false,
  "data": {
    "account": {
      "id": "1a7d2c40-5b1e-4e7a-9d3f-6c2b8e1f0a11",
      "label": "Sale 1",
      "username": "sale_demo_1",
      "tg_user_id": "100200300"
    },
    "peer": {
      "tg_user_id": "456789",
      "name": "Nguyễn Văn A",
      "username": "nva",
      "person_id": "c41b7e2a-9d3c-4b1f-8e2a-7c5d3b1f9e08",
      "stage_id": "3e5f7a9b-1c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "is_contact": true,
      "internal": false
    },
    "conversation_id": "9f2e4b6a-1c3d-4e5f-8a9b-0c1d2e3f4a5b",
    "by": {
      "kind": "human",
      "id": null
    },
    "links": {
      "app": "https://tlg.builera.app/w/07c2e5e1-c42f-4212-851b-c55b6dd7989d/inbox?c=9f2e4b6a-1c3d-4e5f-8a9b-0c1d2e3f4a5b"
    },
    "untrusted_fields": [
      "peer.name"
    ]
  }
}
Was this page helpful?

Last checked: 10/24/2026 · build 2.0