Add custom event
Custom events can be used to add metadata to your conversation. There are some restrictions when using custom events:
- Event type must begin with
custom: - Event type must not exceed 100 characters
- Event type must contain ONLY alphanumeric,
-and_characters - Event body must not exceed 4096 bytes
Example
Ensure the following variables are set to your required values using any convenient method:
| Key | Description |
|---|---|
CONVERSATION_ID | The ID of the Conversation. |
MEMBER_ID | The unique ID of the Member. |
Prerequisites
You will need to use an existing Application that contains a Conversation in order to be able to add a custom event. See the Create Conversation code snippet for information on how to create an Application and some sample Conversations.
Run your code
Save this file to your machine and run it:
Prerequisites
You will need to use an existing Application that contains a Conversation in order to be able to add a custom event. See the Create Conversation code snippet for information on how to create an Application and some sample Conversations.
Create a file named create-custom-event.js and add the following code:
Run your code
Save this file to your machine and run it:
Prerequisites
You will need to use an existing Application that contains a Conversation in order to be able to add a custom event. See the Create Conversation code snippet for information on how to create an Application and some sample Conversations.
Create a file named create-custom-event.php and add the following code:
Run your code
Save this file to your machine and run it:
Try it out
When you run the code you'll see a custom event in your event list