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/v0.3/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

Prerequisites

npm install @vonage/server-sdk

Create a file named create-custom-event.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});

View full source

Write the code

Add the following to create-custom-event.js:

vonage.conversations.createEvent(
  CONVERSATION_ID,
  {
    'type': `custom:${YOUR_EVENT_NAME}`,
    'from': MEMBER_ID,
    'body': {
      'your': 'data',
    },
  },
)
  .then((event) => console.log(event))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node create-custom-event.js

Prerequisites

composer require vonage/client

Create a file named create-custom-event.php and add the following code:

use Vonage\Conversation\ConversationObjects\CreateConversationRequest;
use Vonage\Conversation\ConversationObjects\UpdateConversationRequest;

require_once __DIR__ . '../../config.php';
require_once __DIR__ . '../../vendor/autoload.php';

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

View full source

Write the code

Add the following to create-custom-event.php:

$eventRequest = new \Vonage\Conversation\ConversationObjects\EventRequest(
    CONVERSATION_ID,
    'custom:' . YOUR_EVENT_NAME,
    MEMBER_ID,
    [
        'your' => 'data'
    ]
);

$client->conversation()->createEvent($eventRequest);

View full source

Run your code

Save this file to your machine and run it:

php create-custom-event.php

Try it out

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