Notification recipients

List notification recipients

List notification recipients

GEThttps://app.seedata.io/api/notification-recipients

Query parameters

Response

200

OK

Body

application/json

metadatametadata

Pagination Metadata

itemsarray of Notification Recipient / Alerts

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/notification-recipients', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "metadata": {},
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "type": "email",
      "template": "text",
      "priorities": [
        0
      ],
      "settings": {
        "email": "[e-mail]"
      },
      "status": "pending",
      "createdAt": "2024-05-12T00:28:14.000Z",
      "updatedAt": "2024-05-12T00:28:14.000Z",
      "updatedByType": "text",
      "updatedById": "text",
      "createdByType": "text",
      "createdById": "text"
    }
  ]
}

Create a notification recipient

Create a notification recipient

POSThttps://app.seedata.io/api/notification-recipients

Body

application/json

idstring (uuid)

name*string

descriptionnullable string

type*enum

emailjiraslackteamswebhookservice_nowsyslogsyslog_cef

templatenullable string

prioritiesarray of number

List of priorities for this recipient to be notified

settings*object

EmailSlackWebhookJiraTeamsservice_nowsyslog / syslog_cef

statusenum

pendingactive

createdAtstring (date-time)

updatedAtstring (date-time)

updatedByTypenullable string

updatedByIdnullable string

createdByTypenullable string

createdByIdnullable string

Response

201

Created

Body

application/json

idstring (uuid)

name*string

descriptionnullable string

type*enum

emailjiraslackteamswebhookservice_nowsyslogsyslog_cef

templatenullable string

prioritiesarray of number

List of priorities for this recipient to be notified

settings*object

EmailSlackWebhookJiraTeamsservice_nowsyslog / syslog_cef

statusenum

pendingactive

createdAtstring (date-time)

updatedAtstring (date-time)

updatedByTypenullable string

updatedByIdnullable string

createdByTypenullable string

createdByIdnullable string

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/notification-recipients', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "email",
      "settings": {
        "email": "[e-mail]"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    0
  ],
  "settings": {
    "email": "[e-mail]"
  },
  "status": "pending",
  "createdAt": "2024-05-12T00:28:14.000Z",
  "updatedAt": "2024-05-12T00:28:14.000Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

Get a notification recipient

Get a notification recipient

GEThttps://app.seedata.io/api/notification-recipients/{notificationrecipientsId}

Path parameters

notificationrecipientsId*string

Query parameters

Response

200

OK

Body

application/json

idstring (uuid)

name*string

descriptionnullable string

type*enum

emailjiraslackteamswebhookservice_nowsyslogsyslog_cef

templatenullable string

prioritiesarray of number

List of priorities for this recipient to be notified

settings*object

EmailSlackWebhookJiraTeamsservice_nowsyslog / syslog_cef

statusenum

pendingactive

createdAtstring (date-time)

updatedAtstring (date-time)

updatedByTypenullable string

updatedByIdnullable string

createdByTypenullable string

createdByIdnullable string

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/notification-recipients/{notificationrecipientsId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    0
  ],
  "settings": {
    "email": "[e-mail]"
  },
  "status": "pending",
  "createdAt": "2024-05-12T00:28:14.000Z",
  "updatedAt": "2024-05-12T00:28:14.000Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

Delete a notification recipient

Delete a notification recipient

DELETEhttps://app.seedata.io/api/notification-recipients/{notificationrecipientsId}

Path parameters

notificationrecipientsId*string

Response

204

No Content

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/notification-recipients/{notificationrecipientsId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update a notification recipient

Update a notification recipient

PATCHhttps://app.seedata.io/api/notification-recipients/{notificationrecipientsId}

Path parameters

notificationrecipientsId*string

Body

application/json

idstring (uuid)

name*string

descriptionnullable string

type*enum

emailjiraslackteamswebhookservice_nowsyslogsyslog_cef

templatenullable string

prioritiesarray of number

List of priorities for this recipient to be notified

settings*object

EmailSlackWebhookJiraTeamsservice_nowsyslog / syslog_cef

statusenum

pendingactive

createdAtstring (date-time)

updatedAtstring (date-time)

updatedByTypenullable string

updatedByIdnullable string

createdByTypenullable string

createdByIdnullable string

Response

200

OK

Body

application/json

idstring (uuid)

name*string

descriptionnullable string

type*enum

emailjiraslackteamswebhookservice_nowsyslogsyslog_cef

templatenullable string

prioritiesarray of number

List of priorities for this recipient to be notified

settings*object

EmailSlackWebhookJiraTeamsservice_nowsyslog / syslog_cef

statusenum

pendingactive

createdAtstring (date-time)

updatedAtstring (date-time)

updatedByTypenullable string

updatedByIdnullable string

createdByTypenullable string

createdByIdnullable string

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/notification-recipients/{notificationrecipientsId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "email",
      "settings": {
        "email": "[e-mail]"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    0
  ],
  "settings": {
    "email": "[e-mail]"
  },
  "status": "pending",
  "createdAt": "2024-05-12T00:28:14.000Z",
  "updatedAt": "2024-05-12T00:28:14.000Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}