Join us in San Francisco on the 29/30th of October for two days of developer workshops and technical talks

Add custom event

Custom events can be used to add metadata to your conversation. There are some restrictions when using custom events:

Example

Ensure the following variables are set to your required values using any convenient method:

Key Description
CONVERSATION_ID The unique ID of the Conversation.
MEMBER_ID The unique ID of the Member.

Prerequisites

Use your existing application

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:

Copy to Clipboard
# `from` is only required if you're using a JWT with a `sub` claim
curl -X "POST" "https://api.nexmo.com/beta/conversations/$CONVERSATION_ID/events" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json' \
     -d $'{
  "type": "custom:YOUR_EVENT_NAME",
  "from": "'$MEMBER_ID'",
  "body": {
    "your": "data"
  }
}'

View full source

Run your code

Save this file to your machine and run it:

sh create-custom-event.sh

Try it out

When you run the code you'll see a custom event in your event list