getOrCreateUser

Get or create a new User

POST /users/get-or-create

Get Or Create User

cURL

curl --request POST \
  --url https://chat.botpress.cloud/{webhookUrl}/users/get-or-create \
  --header 'Content-Type: application/json' \
  --header 'x-user-key: <x-user-key>' \
  --data '
{
  "name": "<string>",
  "pictureUrl": "<string>",
  "profile": "<string>"
}
'

201

{
  "user": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "pictureUrl": "<string>",
    "profile": "<string>"
  }
}

Headers

x-user-key · string · required

Authentication Key

Body

application/json

User data

name · string

Name of the User (not a unique identifier)

pictureUrl · string

Picture url of the User

profile · string

Custom profile data of the User encoded as a string

Maximum string length: 1000

Response

201

application/json

Returns a User

user · object · required

The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.

Show child attributes