API Reference

Start Engagement

post
https://engagement-api.pypestream.com/messaging/v1/chats//start

Use this method to start an engagement.

Path Params
uuid
required

The 'chat_id' received with the Create User response

Body Params

Starts an Engagement

uuid
required

The 'app_id' sent when creating a user

string
required

The ID of the consumer.

string
required

Platform used by the client app. Possible value(s): pypestream_widget

uuid
required

The 'web_chat_stream_id' received with the Create User response.

uuid
required

The 'id' received with the Create User response.

string
required

API version

Responses
202

Successful operation

Callback

Updated 8 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago