Sent when user scope data is created, modified, or deleted.

If subscribed, whenever a user is created, modified or deleted in the context of a bot flow, bot component or Meya API, a user event will be sent to your Webhook URL.

Use-cases:

  • keep user databases in sync
  • event-based workflows

User event object

FieldDescription
type
string
Always user
bot_id
string
The id of the bot associated with the data ex. BJty7evfw2b
user_id
string
Not used. Always null
sender
string
Always bot
timestamp
float
UNIX timestamp of the change to 5 decimal precision. ex 1487093050.56191
operation
string
One of insert, modify, remove
user
object
The up-to-date user model
{
    "user_id": null,
    "user": {
        "first_name": "Leonhard",
        "last_name": "Euler",
        "user_id": null,
        "citizenship": [
            "Swiss"
        ],
        "locale": "de_CH",
        "gender": "male",
        "profession": "mathematician",
        "integration": null,
        "alive": false,
        "avatar_url": "https://upload.wikimedia.org/wikipedia/commons/d/d7/Leonhard_Euler.jpg",
        "id": "UxWjhUrnRBN",
        "bot_id": "BJty7evfw2b"
    },
    "timestamp": 1487093050.56191,
    "operation": "modify",
    "bot_id": "BJty7evfw2b",
    "type": "user",
    "sender": "bot"
}

📘

Debug mode

If debug mode is turned on in your API & Webhook integration on Meya admin, test chat user events will be sent as well.