Skip to content
/
Retrieve all webtasks

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

Campaign

Operations

Campaign

Operations

Contact

Operations

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Retrieve all webtasks

Request

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/webtasks \
  -H 'X-Key: string'

Responses

A list of webtasks

Bodyapplication/jsonArray [
idinteger(int32)

The webTask's id

namestring

The webTask's name

descriptionstring

The webTask's description

creationDatestring(date-time)

The webTask's creation date

scriptingobject

The webTask's script settings

versionstring
Discriminator
environmentobject

Environment definition

importsArray of objects

Imports definition

initializersArray of objects

Initializers definition

filtersArray of objects

Filters definition

settingsobject

The webTask's settings

valuestring

The webTask's script

]
Response
application/json
[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "scripting": {
      "version": "string"
    },
    "settings": {},
    "value": "string"
  }
]

Create a webtask

Request

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 create the webtask

idinteger(int32)

The webTask's id

namestring

The webTask's name

descriptionstring

The webTask's description

creationDatestring(date-time)

The webTask's creation date

scriptingobject

The webTask's script settings

versionstring
Discriminator
environmentobject

Environment definition

importsArray of objects

Imports definition

initializersArray of objects

Initializers definition

filtersArray of objects

Filters definition

settingsobject

The webTask's settings

valuestring

The webTask's script

curl -i -X POST \
  https://api-cm.np6.com/scripting/webtasks \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": 0,
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "scripting": {
      "version": "string"
    },
    "settings": {},
    "value": "string"
  }'

Responses

The created webtask

Bodyapplication/json
idinteger(int32)

The webTask's id

namestring

The webTask's name

descriptionstring

The webTask's description

creationDatestring(date-time)

The webTask's creation date

scriptingobject

The webTask's script settings

versionstring
Discriminator
environmentobject

Environment definition

importsArray of objects

Imports definition

initializersArray of objects

Initializers definition

filtersArray of objects

Filters definition

settingsobject

The webTask's settings

valuestring

The webTask's script

Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "scripting": {
    "version": "string"
  },
  "settings": {},
  "value": "string"
}

Retrieve the specified webtask

Request

Path
idinteger(int32)required

The webtask's id to get

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/webtasks/{id}' \
  -H 'X-Key: string'

Responses

A webtask

Bodyapplication/json
idinteger(int32)

The webTask's id

namestring

The webTask's name

descriptionstring

The webTask's description

creationDatestring(date-time)

The webTask's creation date

scriptingobject

The webTask's script settings

versionstring
Discriminator
environmentobject

Environment definition

importsArray of objects

Imports definition

initializersArray of objects

Initializers definition

filtersArray of objects

Filters definition

settingsobject

The webTask's settings

valuestring

The webTask's script

Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "scripting": {
    "version": "string"
  },
  "settings": {},
  "value": "string"
}

Compilable

Operations

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.