Trigger

The Trigger API allows you to list, create, update, search by ID, and delete event triggers.

Refer to the Trigger API calls below:

• List triggers
• Create trigger
• Get trigger by ID
• Delete trigger by ID

List triggers

Endpoints

GET notificationsvc/api/v1/trigger

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_count	Integer	Number of triggers to be listed. Default is 10.	Required
_offset?	Integer	Position in list of triggers to begin listing	Required
_name	String	Name of trigger	Required
_namespace	String	Project namespace	Optional

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _offset?: integer
  _pageSize?: integer
  _total?: integer
  _list: {
    _id?: string
    _namespaces?: string[]
    _createdAt?: string
    _updatedAt?: string
    _version?: integer
    _name: string
    _description?: string
    _type: enum[EVENT]
    _event: {
      _filters: {
      }
    }
    _script: {
      id?: string
      userType?: string
      name?: string
      versionId?: string
    }
    _senders: {
      _id?: string
    }[]
    _templates:#/components/schemas/Ref[]
    _groups:#/components/schemas/Ref[]
  }[]
}

Create trigger

Endpoints

POST notificationsvc/api/v1/trigger

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_count	Integer	Number of triggers to be listed. Default is 10.	Required
_offset?	Integer	Position in list of triggers to begin listing	Required
_name	String	Name of trigger	Required
_namespace	String	Project namespace	Optional

Request body example

{
  _description?: string
  _type: enum[EVENT]
  _event: {
    _filters: {
    }
  }
  _script: {
    id?: string
    userType?: string
    name?: string
    versionId?: string
  }
  _senders: {
    _id?: string
  }[]
  _templates:#/components/schemas/Ref[]
  _groups:#/components/schemas/Ref[]
  _namespaces?: string[]
  _name: string
}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _id?: string
  _namespaces?: string[]
  _createdAt?: string
  _updatedAt?: string
  _version?: integer
  _name: string
  _description?: string
  _type: enum[EVENT]
  _event: {
    _filters: {
    }
  }
  _script: {
    id?: string
    userType?: string
    name?: string
    versionId?: string
  }
  _senders: {
    _id?: string
  }[]
  _templates:#/components/schemas/Ref[]
  _groups:#/components/schemas/Ref[]
}

Get trigger by ID

Endpoints

GET notificationsvc/api/v1/trigger/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_id	String	ID to search for

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _id?: string
  _namespaces?: string[]
  _createdAt?: string
  _updatedAt?: string
  _version?: integer
  _name: string
  _description?: string
  _type: enum[EVENT]
  _event: {
    _filters: {
    }
  }
  _script: {
    id?: string
    userType?: string
    name?: string
    versionId?: string
  }
  _senders: {
    _id?: string
  }[]
  _templates:#/components/schemas/Ref[]
  _groups:#/components/schemas/Ref[]
}

Delete trigger by ID

Endpoints

DELETE notificationsvc/api/v1/trigger/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_version	String	Version to apply

Request body example

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response