Get audit events

In this building block you see how to get a list of audit events.

Example

You will need to ensure that the following replaceable values are set in the example code using any convenient method:

Key Description
NEXMO_API_KEY Your Nexmo API key.
NEXMO_API_SECRET Your Nexmo API secret.

In the following example the Create an application and Initialize your dependencies procedures are optional.

Prerequisites

Create an application

A Nexmo application contains the required configuration for your project. You can create an application using the Nexmo CLI  (see below) or via the dashboard  . To learn more about applications see our Nexmo concepts guide.

Install the CLI

$ npm install -g nexmo-cli

Create an application

Once you have the CLI installed you can use it to create a Nexmo application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID in the example below. It will also create private.key in the current directory which you will need in the Initialize your dependencies step

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok  to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

$ nexmo app:create "Get Events"  http://demo.ngrok.io/webhooks/events --keyfile private.key
Initialize your dependencies

Create a file named get-events.sh and add the following code:

Copy to Clipboard
source "../config.sh"

View full source 

Write the code

Add the following to get-events.sh:

Copy to Clipboard
curl "https://api.nexmo.com/beta/audit/events" \
     -u "$NEXMO_API_KEY:$NEXMO_API_SECRET"

View full source 

Run your code

Save this file to your machine and run it:

$ ./get-events.sh

Try it out

Run the command in a shell. The call will retrieve a list of audit events.