Skip to content
/
Update listeners of the s...

NP6 API Reference (8.1.0)

This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.

If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.

Languages
Servers
Production server
https://api-cm.np6.com

Email & SMS

Operations

Notification

Operations

Archives

Operations

Email & SMS

Operations

Notification

Operations

Display

Operations

Email & SMS

Operations

Notification

Operations

Workflow

Operations

Retrieve listeners of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to retrieve listeners

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X GET \
  'https://api-cm.np6.com/scripting/workflows/{id}/listeners' \
  -H 'X-Key: string'

Responses

An array of listeners

Bodyapplication/jsonArray [
idstring

The listener's id

namestring

The listener's name

descriptionstring

The listener's description

eventobject

The listener's event

typestring
Discriminator
filterstring

A trigger filter

handlerstring

The listener's node handler

]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "event": {
      "type": "string"
    },
    "handler": "string"
  }
]

Update listeners of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to update listeners

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/json

Data used to update listeners of the workflow

Array [
idstring

The listener's id

namestring

The listener's name

descriptionstring

The listener's description

eventobject

The listener's event

typestring
Discriminator
filterstring

A trigger filter

handlerstring

The listener's node handler

]
curl -i -X PUT \
  'https://api-cm.np6.com/scripting/workflows/{id}/listeners' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '[
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "event": {
        "type": "string"
      },
      "handler": "string"
    }
  ]'

Responses

An array of updated listeners

Bodyapplication/jsonArray [
idstring

The listener's id

namestring

The listener's name

descriptionstring

The listener's description

eventobject

The listener's event

typestring
Discriminator
filterstring

A trigger filter

handlerstring

The listener's node handler

]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "event": {
      "type": "string"
    },
    "handler": "string"
  }
]

Delete listeners of the specified workflow

Request

Path
idinteger(int32)required

The workflow's id to delete listeners

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X DELETE \
  'https://api-cm.np6.com/scripting/workflows/{id}/listeners' \
  -H 'X-Key: string'

Responses

No Content

Campaign

Operations

Campaign

Operations

Contact

Operations

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.