Sender

The Sender API to list, create, update, search by ID, and delete notification senders.

List senders

Endpoints

GET notificationsvc/api/v1/sender

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_count	Integer	Number of templates. Default is 10.	Required
_offset	Integer	Position in list of templates to begin listing	Required
_name	String	Name of subscription	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[]    _name: string    _description?: string    _createdAt?: string    _updatedAt?: string    _version?: integer    _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]    _email: {      _address: string      _displayName?: string    }    _webhook: {      _userAgent?: string    }    _templates: {    }    _redirects: {    }  }[]}

Create sender

Endpoints

POST notificationsvc/api/v1/sender

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional

Request body example

{  _description?: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _email: {    _address: string    _displayName?: string  }  _webhook: {    _userAgent?: string  }  _templates: {  }  _redirects: {  }  _name: string  _namespaces?: string[]}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _id?: string  _namespaces?: string[]  _name: string  _description?: string  _createdAt?: string  _updatedAt?: string  _version?: integer  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _email: {    _address: string    _displayName?: string  }  _webhook: {    _userAgent?: string  }  _templates: {  }  _redirects: {  }}

Get sender by ID

Endpoints

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

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _id?: string  _namespaces?: string[]  _name: string  _description?: string  _createdAt?: string  _updatedAt?: string  _version?: integer  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _email: {    _address: string    _displayName?: string  }  _webhook: {    _userAgent?: string  }  _templates: {  }  _redirects: {  }}

Update sender by ID

Endpoints

PUT notificationsvc/api/v1/sender/{id}

Request

Request body

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

Request body example

{  _description?: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _email: {    _address: string    _displayName?: string  }  _webhook: {    _userAgent?: string  }  _templates: {  }  _redirects: {  }}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _id?: string  _namespaces?: string[]  _name: string  _description?: string  _createdAt?: string  _updatedAt?: string  _version?: integer  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _email: {    _address: string    _displayName?: string  }  _webhook: {    _userAgent?: string  }  _templates: {  }  _redirects: {  }}

Delete sender by ID

Endpoints

DELETE notificationsvc/api/v1/sender/{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