Documentation

Mistake on this page? Email us

Connect API

The API can be initalized with a .env file in the working directory with the following values

MBED_CLOUD_SDK_API_KEY=

and optionally

MBED_CLOUD_SDK_HOST= (defaults to https://api.us-east-1.mbedcloud.com)

OR

This API is initialized with ConnectionOptions.

To create an instance of this API in Node.js:

var MbedCloudSDK = require("mbed-cloud-sdk");

var connect = new MbedCloudSDK.ConnectApi({
    apiKey: "<Mbed Cloud API Key>"
});

To create an instance of this API in the browser:

<script src="<mbed-cloud-sdk>/bundles/connect.min.js"></script>

<script>
    var connect = new MbedCloudSDK.ConnectApi({
        apiKey: "<Mbed Cloud API Key>"
    });
</script>

Notification channels

Some methods on connected device resources (e.g. resource.getValue()) and most events (e.g. resource.on("notification")) require a notification channel to be set up before they will work.

There are two options for setting up a notification channel:

  • Use pull notifications by using startNotifications() (the default which starts automatically)
  • Register a callback server or webhook using updateWebhook()

The webhook and pull-notifications examples show how this can be done.

Hierarchy

  • EventEmitter
    • ConnectApi

Index

Constructors

constructor

Events

EVENT_DEREGISTRATION

EVENT_DEREGISTRATION: string = "deregistration"

List of devices that were removed in a controlled manner

EVENT_EXPIRED

EVENT_EXPIRED: string = "expired"

List of devices that were removed because the registration has expired

EVENT_NOTIFICATION

EVENT_NOTIFICATION: string = "notification"

Resource notification event

EVENT_REGISTRATION

EVENT_REGISTRATION: string = "registration"

List of new devices that have registered (with resources)

EVENT_REREGISTRATION

EVENT_REREGISTRATION: string = "reregistration"

List of devices that have updated registration

Properties

subscribe

subscribe: Subscribe

Gives you access to the subscribe manager

defaultMaxListeners

defaultMaxListeners: number

Accessors

handleNotifications

handleNotifications:

Whether the user will handle notifications This suppresses pull notifications for when another method is being used (such as webhooks)

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

addResourceSubscription

  • addResourceSubscription(deviceId: string, resourcePath: string, notifyFn?: function): Promise<void>
  • Subscribe to a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.addResourceSubscription(deviceId, resourceURI, data => {
        // Utilize data here - which is the updated value in resourceURI
    })
    .then(asyncId => {
        // Utilize asyncId here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • Optional notifyFn: function

      Function to call with notification

        • (data: any): any
        • Parameters

          • data: any

          Returns any

    Returns Promise<void>

    empty Promise

  • addResourceSubscription(deviceId: string, resourcePath: string, notifyFn?: function, callback?: CallbackFn<void>): void
  • Subscribe to a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.addResourceSubscription(deviceId, resourceURI, function(data) {
         // Utilize data here - which is the updated value in resourceURI
    }, function(error, asyncId) {
        if (error) throw error;
        // Utilize asyncId here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • Optional notifyFn: function

      Function to call with notification

        • (data: any): any
        • Parameters

          • data: any

          Returns any

    • Optional callback: CallbackFn<void>

      A function that is passed any error

    Returns void

deleteDeviceSubscriptions

  • deleteDeviceSubscriptions(deviceId: string): Promise<void>
  • Removes a device's subscriptions

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    connect.deleteDeviceSubscriptions(deviceId)
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    Returns Promise<void>

    Promise containing any error

  • deleteDeviceSubscriptions(deviceId: string, callback: CallbackFn<void>): void
  • Removes a device's subscriptions

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    connect.deleteDeviceSubscriptions(deviceId, function(error) {
        if (error) throw error;
    });

    Parameters

    • deviceId: string

      Device ID

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

deletePresubscriptions

  • deletePresubscriptions(): Promise<void>
  • Deletes pre-subscription data

    Example:

    connect.deletePresubscriptions()
    .catch(error => {
        console.log(error);
    });

    Returns Promise<void>

    Promise containing any error

  • deletePresubscriptions(callback: CallbackFn<void>): void
  • Deletes pre-subscription data

    Example:

    connect.deletePresubscriptions(function(error) {
        if (error) throw error;
    });

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

deleteResourceSubscription

  • deleteResourceSubscription(deviceId: string, resourcePath: string): Promise<void>
  • Deletes a resource's subscription

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.deleteResourceSubscription(deviceId, resourceURI)
    .then(response => {
        // Utilize response here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    Returns Promise<void>

    empty Promise

  • deleteResourceSubscription(deviceId: string, resourcePath: string, callback: CallbackFn<void>): void
  • Deletes a resource's subscription

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.deleteResourceSubscription(deviceId, resourceURI, function(error, response) {
        if (error) throw error;
        // Utilize response here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

deleteSubscriptions

  • deleteSubscriptions(): Promise<void>
  • Removes all subscriptions for all devices.

    Warning: This could be slow for large numbers of connected devices. If possible, explicitly delete subscriptions known to have been created.

    Example:

    connect.deleteSubscriptions()
    .catch(error => {
        console.log(error);
    });

    Returns Promise<void>

    Promise containing any error

  • deleteSubscriptions(callback: CallbackFn<void>): void
  • Removes all subscriptions for all devices.

    Warning: This could be slow for large numbers of connected devices. If possible, explicitly delete subscriptions known to have been created.

    Example:

    connect.deleteSubscriptions(function(error) {
        if (error) throw error;
    });

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

deleteWebhook

  • deleteWebhook(): Promise<void>
  • Deletes the callback data (effectively stopping Mbed Cloud Connect from putting notifications)

    If no webhook is registered, an exception (404) will be raised.

    Note that every registered subscription will be deleted as part of deregistering a webhook.

    Example:

    connect.deleteWebhook()
    .catch(error => {
        console.log(error);
    });

    Returns Promise<void>

    Promise containing any error

  • Deletes the callback data (effectively stopping Mbed Cloud Connect from putting notifications)

    If no webhook is registered, an exception (404) will be raised.

    Note that every registered subscription will be deleted as part of deregistering a webhook.

    Example:

    connect.deleteWebhook(function(error) {
        if (error) throw error;
    });

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

executeResource

  • executeResource(deviceId: string, resourcePath: string, mimeType?: string): Promise<AsyncResponse>
  • Execute a function on a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.executeResource(deviceId, resourceURI)
    .then(response => {
        // Utilize response here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • Optional mimeType: string

      The mime type format of the value

    Returns Promise<AsyncResponse>

    the AsyncResponse

  • executeResource(deviceId: string, resourcePath: string, mimeType?: string, callback?: CallbackFn<AsyncResponse>): void
  • Execute a function on a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.executeResource(deviceId, resourceURI, function(error, response) {
        if (error) throw error;
        // Utilize response here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • Optional mimeType: string

      The mime type format of the value

    • Optional callback: CallbackFn<AsyncResponse>

      A function that is passed any error

    Returns void

getLastApiMetadata

  • Get meta data for the last Mbed Cloud API call

    Returns Promise<ApiMetadata>

    Promise of meta data

  • Get meta data for the last Mbed Cloud API call

    Parameters

    Returns void

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getResource

  • getResource(deviceId: string, resourcePath: string): Promise<Resource>
  • Get a resource

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.getResource(deviceId, resourceURI)
    .then(resource => {
        // Utilize resource here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Path of the resource to get

    Returns Promise<Resource>

    Promise of device resource

  • getResource(deviceId: string, resourcePath: string, callback?: CallbackFn<Resource>): void
  • Get a resource

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.getResource(deviceId, resourceURI, function(error, resource) {
        if (error) throw error;
        // Utilize resource here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Path of the resource to get

    • Optional callback: CallbackFn<Resource>

      A function that is passed the arguments (error, resource)

    Returns void

getResourceSubscription

  • getResourceSubscription(deviceId: string, resourcePath: string): Promise<boolean>
  • Gets the status of a resource's subscription

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.getResourceSubscription(deviceId, resourceURI)
    .then(res_exists => {
        // Utilize res_exists here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    Returns Promise<boolean>

    Promise containing resource subscription status

  • getResourceSubscription(deviceId: string, resourcePath: string, callback: CallbackFn<boolean>): void
  • Gets the status of a resource's subscription

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.getResourceSubscription(deviceId, resourceURI, function(error, res_exists) {
        if (error) throw error;
        // Utilize res_exists here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • callback: CallbackFn<boolean>

      A function that is passed (error, subscribed) where subscribed is true or false

    Returns void

getResourceValue

  • getResourceValue(deviceId: string, resourcePath: string, mimeType?: string): Promise<string | number | void>
  • Gets the value of a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.getResourceValue(deviceId, resourceURI)
    .then(data => {
        // Utilize data here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • Optional mimeType: string

      The requested mime type format of the value

    Returns Promise<string | number | void>

    Promise of resource value

  • getResourceValue(deviceId: string, resourcePath: string, mimeType?: string, callback?: CallbackFn<string | number | void>): void
  • Gets the value of a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    connect.getResourceValue(deviceId, resourceURI, function(error, data) {
        if (error) throw error;
        // Utilize data here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • Optional mimeType: string

      The requested mime type format of the value

    • Optional callback: CallbackFn<string | number | void>

      A function that is passed the arguments (error, value)

    Returns void

getWebhook

  • Get the current callback URL if it exists

    Example:

    connect.getWebhook()
    .then(webhook => {
        // Utilize webhook here
    })
    .catch(error => {
        console.log(error);
    });

    Returns Promise<Webhook>

    Promise containing the webhook data

  • Get the current callback URL if it exists

    Example:

    connect.getWebhook(function(error, webhook) {
        if (error) throw error;
        // Utilize webhook here
    });

    Parameters

    • callback: CallbackFn<Webhook>

      A function that is passed the arguments (error, webhook)

    Returns void

listConnectedDevices

  • List connected devices

    Example:

    connect.listConnectedDevices({
        filter: {
            createdAt: { $gte: new Date("01-01-2014"), $lte: new Date("01-01-2018") },
            updatedAt: { $gte: new Date("01-01-2014"), $lte: new Date("01-01-2018") }
        }
    })
    .then(devices => {
        // Utilize devices here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    Returns Promise<ListResponse<ConnectedDevice>>

    Promise of connected devices

  • List connected devices

    Example:

    connect.listConnectedDevices({
        filter: {
            createdAt: { $gte: new Date("01-01-2014"), $lte: new Date("01-01-2018") },
            updatedAt: { $gte: new Date("01-01-2014"), $lte: new Date("01-01-2018") }
        }
    }, function(error, devices) {
        if (error) throw error;
        // Utilize devices here
    });

    Parameters

    Returns void

listDeviceSubscriptions

  • listDeviceSubscriptions(deviceId: string): Promise<string>
  • List a device's subscriptions

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    connect.listDeviceSubscriptions(deviceId)
    .then(subscriptions => {
        // Utilize subscriptions here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    Returns Promise<string>

    Promise containing the subscriptions

  • listDeviceSubscriptions(deviceId: string, callback: CallbackFn<string>): void
  • List a device's subscriptions

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    connect.listDeviceSubscriptions(deviceId, function(error, subscriptions) {
        if (error) throw error;
        // Utilize subscriptions here
    });

    Parameters

    • deviceId: string

      Device ID

    • callback: CallbackFn<string>

      A function that is passed (error, subscriptions)

    Returns void

listMetrics

  • List metrics

    Example: (The following will retrieve metrics regarding pending and failed device registrations in the last day)

    var today = new Date();
    var yesterday = new Date();
    yesterday.setDate(yesterday.getDate() - 1);
    var options = {start: yesterday, end: today, include: ["pendingBootstraps", "failedBootstraps"]};
    connect.listMetrics(options)
    .then(metrics => {
        // Utilize metrics here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    Returns Promise<ListResponse<Metric>>

    Promise of metrics

  • List metrics

    Example: (The following will retrieve metrics regarding pending and failed device registrations in the last day)

    var today = new Date();
    var yesterday = new Date();
    yesterday.setDate(yesterday.getDate() - 1);
    var options = {start: yesterday, end: today, include: ["pendingBootstraps", "failedBootstraps"]};
    connect.listMetrics(options, function(error, metrics) {
        if (error) throw error;
        // Utilize metrics here
    });

    Parameters

    Returns void

listPresubscriptions

  • Gets a list of pre-subscription data

    Example:

    connect.listPresubscriptions()
    .then(presubscriptions => {
        // Utilize presubscriptions here
    })
    .catch(error => {
        console.log(error);
    });

    Returns Promise<Array<PresubscriptionObject>>

    Promise containing pre-subscriptions

  • Gets a list of pre-subscription data

    Example:

    connect.listPresubscriptions(function(error, presubscriptions) {
        if (error) throw error;
        // Utilize presubscriptions here
    });

    Parameters

    Returns void

listResources

  • listResources(deviceId: string): Promise<Array<Resource>>
  • List device's resources

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    connect.listResources(deviceId)
    .then(resources => {
        for (var resource in resources) {
            // Utilize resource here
            console.log(resources[resource]);
        }
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    Returns Promise<Array<Resource>>

    Promise of device resources

  • List device's resources

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    connect.listResources(deviceId, function(error, resources) {
        if (error) throw error;
        for (var resource in resources) {
            // Utilize resource here
            console.log(resources[resource]);
        }
    });

    Parameters

    • deviceId: string

      Device ID

    • callback: CallbackFn<Array<Resource>>

      A function that is passed the arguments (error, resources)

    Returns void

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

notify

  • Allows a notification to be injected into the notifications system

    handleNotifications needs to be set to true for this to work with web hook async responses

    Example: (The following pushes a notification to the event emitter, which can be read back by using the .on function. Note that the payload is encoded in Base64)

    var deviceID = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    var payload = "Q2hhbmdlIG1lIQ==";
    
    var notification = {notifications: [{ep: deviceID, path: resourceURI, payload: payload}]};
    connectApi.notify(notification);
    
    connectApi.on(mbed.ConnectApi.EVENT_NOTIFICATION, function(notification) {
        // Do something with the notification
        console.log(notification);
    });

    Console log:

    { id: '015bb66a92a30000000000010010006d', path: '3200/0/5500', payload: 'Change me!'}

    Parameters

    Returns void

on

  • on(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

setResourceValue

  • setResourceValue(deviceId: string, resourcePath: string, value: string | number, mimeType?: string): Promise<AsyncResponse>
  • Sets the value of a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    var payload = "ChangeMe!";
    connect.setResourceValue(deviceId, resourceURI, payload)
    .then(response => {
        // Utilize response here
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • value: string | number

      The value of the resource

    • Optional mimeType: string

      The mime type format of the value

    Returns Promise<AsyncResponse>

    the AsyncResponse

  • setResourceValue(deviceId: string, resourcePath: string, value: string | number, mimeType?: string, callback?: CallbackFn<AsyncResponse>): void
  • Sets the value of a resource

    Note: This method requires a notification channel to be set up

    Example:

    var deviceId = "015bb66a92a30000000000010010006d";
    var resourceURI = "/3200/0/5500";
    var payload = "ChangeMe!";
    connect.setResourceValue(deviceId, resourceURI, payload, function(error, response) {
        if (error) throw error;
        // Utilize response here
    });

    Parameters

    • deviceId: string

      Device ID

    • resourcePath: string

      Resource path

    • value: string | number

      The value of the resource

    • Optional mimeType: string

      The mime type format of the value

    • Optional callback: CallbackFn<AsyncResponse>

      A function that is passed any error

    Returns void

startNotifications

  • Begins pull notifications

    If an external callback is not setup (using update_webhook), then calling this function is mandatory.

    Example:

    connect.startNotifications()
    .then(() => {
        console.log('Mbed Cloud SDK listening for notifications');
    })
    .catch(error => {
        console.log(error);
    });

    Parameters

    Returns Promise<void>

    Promise containing any error

  • Begins pull notifications

    If an external callback is not setup (using update_webhook), then calling this function is mandatory.

    Example:

    connect.startNotifications(function(error) {
        if (error) return console.log(error);
        console.log('Mbed Cloud SDK listening for notifications');
    });

    Parameters

    Returns void

stopNotifications

  • stopNotifications(): Promise<void>
  • Stops pull notifications

    Example:

    connect.stopNotifications()
    .then(() => {
        console.log('Mbed Cloud SDK stopped listening for notifications');
    })
    .catch(error => {
        console.log(error);
    });

    Returns Promise<void>

    Promise containing any error

  • stopNotifications(callback: CallbackFn<void>): void
  • Stops pull notifications

    Example:

    connect.stopNotifications(function(error) {
        if (error) throw error;
        console.log('Mbed Cloud SDK stopped listening for notifications');
    });

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

updatePresubscriptions

  • Update pre-subscription data

    Example:

    var deviceID = "015bb66a92a30000000000010010006d";
    var subscriptions = [{deviceId: deviceID}];
    connect.updatePresubscriptions(subscriptions)
    .catch(error => {
        console.log(error);
    });

    Parameters

    • subscriptions: Array<PresubscriptionObject>

      The pre-subscription data array. If you send an empty array, the pre-subscription data will be removed

    Returns Promise<void>

    Promise containing any error

  • Update pre-subscription data

    Example:

    var deviceID = "015bb66a92a30000000000010010006d";
    var subscriptions = [{deviceId: deviceID}];
    connect.updatePresubscriptions(subscriptions, function(error) {
        if (error) throw error;
    });

    Parameters

    • subscriptions: Array<PresubscriptionObject>

      The pre-subscription data array. If you send an empty array, the pre-subscription data will be removed

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

updateWebhook

  • updateWebhook(url: string, headers?: object, forceClear?: boolean): Promise<void>
  • Register new webhook for incoming subscriptions.

    If a webhook is already set, this will do an overwrite.

    Example:

    connect.updateWebhook(url)
    .catch(error => {
        console.log(error);
    });

    Parameters

    • url: string

      The URL to which the notifications must be sent

    • Optional headers: object

      Any headers (key/value) that must be sent with the request

      • [key: string]: string
    • Optional forceClear: boolean

      Whether to clear any existing notification channel

    Returns Promise<void>

    Promise containing any error

  • updateWebhook(url: string, headers?: object, forceClear?: boolean, callback?: CallbackFn<void>): void
  • Register new webhook for incoming subscriptions.

    If a webhook is already set, this will do an overwrite.

    Example:

    connect.updateWebhook(url, function(error) {
        if (error) throw error;
    });

    Parameters

    • url: string

      The URL to which the notifications must be sent

    • Optional headers: object

      Any headers (key/value) that must be sent with the request

      • [key: string]: string
    • Optional forceClear: boolean

      Whether to clear any existing notification channel

    • Optional callback: CallbackFn<void>

      A function that is passed any error

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number