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.
Write the code
Add the following to create-custom-event.sh:
# `from` is only required if you're using a JWT with a `sub` claim
curl -X "POST" "https://api.nexmo.com/v1/conversations/$CONV_ID/events" \
-H 'Authorization: Bearer '$JWT\
-H 'Content-Type: application/json' \
-d $'{
"type": "custom:YOUR_EVENT_NAME",
"from": "'$CONV_EVENT_FROM'",
"body": {
"your": "data"
}
}'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.
npm install @vonage/server-sdkCreate 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.
Add the following to build.gradle:
Create a file named CreateCustomEvent and add the following code to the main method:
Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.conversation with the package containing CreateCustomEvent:
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.
Install-Package VonageCreate a file named CreateCustomEvent.cs and add the following code:
Add the following to CreateCustomEvent.cs:
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.
composer require vonage/clientCreate 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