Status200
Ресурс

Status Page Subscriber

Subscriber that subscribed to your status page

Модель Status Page Subscriber

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    statusPage
    Тип
    Status Page
    Описание

    Relation to Status Page Resource in which this object belongs

  • Имя
    statusPageId
    Тип
    Object IDОбязательно
    Описание

    ID of your Status Page resource where this object belongs

  • Имя
    subscriberEmail
    Тип
    Email
    Описание

    Email address of the subscriber.

  • Имя
    subscriberPhone
    Тип
    Phone
    Описание

    Phone number of subscriber

  • Имя
    subscriberWebhook
    Тип
    Short URL
    Описание

    Webhook to ping when events happen on Status Page

  • Имя
    slackIncomingWebhookUrl
    Тип
    Short URL
    Описание

    Slack incoming webhook URL to send notifications to Slack channel

  • Имя
    slackWorkspaceName
    Тип
    Text
    Описание

    Name of the Slack workspace for validation and identification

  • Имя
    microsoftTeamsIncomingWebhookUrl
    Тип
    URL
    Описание

    Microsoft Teams incoming webhook URL to send notifications to Teams channel

  • Имя
    microsoftTeamsWorkspaceName
    Тип
    Very Long Text
    Описание

    Name of the Microsoft Teams workspace for validation and identification

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    isSubscriptionConfirmed
    Тип
    Boolean
    Описание

    Has subscriber confirmed their subscription? (for example, by clicking on a confirmation link in an email)

  • Имя
    subscriptionConfirmationToken
    Тип
    Text
    Описание

    Token used to confirm subscription. This is a random token that is sent to the subscriber's email address to confirm their subscription.

  • Имя
    isUnsubscribed
    Тип
    Boolean
    Описание

    Is Subscriber Unsubscribed?

  • Имя
    sendYouHaveSubscribedMessage
    Тип
    Boolean
    Описание

    Send You Have Subscribed Message when subscriber is created?

  • Имя
    isSubscribedToAllResources
    Тип
    Boolean
    Описание

    Is Subscriber Subscribed to All Resources on this status page?

  • Имя
    isSubscribedToAllEventTypes
    Тип
    Boolean
    Описание

    Is Subscriber Subscribed to All Event Types (like Incidents, Scheduled Events, Announcements) on this status page?

  • Имя
    statusPageResources
    Тип
    Status Page Resource
    Описание

    Relation to Status Page Resources where this subscriber is subscribed to

  • Имя
    statusPageEventTypes
    Тип
    JSON
    Описание

    Which event types is the subscriber subscribed to (like Incidents, Scheduled Events, Announcements)

  • Имя
    internalNote
    Тип
    Markdown
    Описание

    Any notes or text you would like to add to this subscriber object. This is for internal use only.

GETorPOST/api/status-page-subscriber/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Status Page Subscriber». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/status-page-subscriber/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "statusPageId": true,
    "createdByUserId": true,
    "subscriberEmail": true,
    "subscriberWebhook": true
  },
  "query": {
    "microsoftTeamsWorkspaceName": "Example microsoft teams workspace name"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377d7890-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "subscriberEmail": "subscriber@example.com",
      "subscriberWebhook": "https://example.com/webhook"
    },
    {
      "_id": "377d7891-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "subscriberEmail": "subscriber@example.com",
      "subscriberWebhook": "https://example.com/webhook"
    },
    {
      "_id": "377d7892-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "subscriberEmail": "subscriber@example.com",
      "subscriberWebhook": "https://example.com/webhook"
    }
  ]
}
GETorPOST/api/status-page-subscriber/:id/get-item

Получить по ID

Возвращает объект «Status Page Subscriber» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/status-page-subscriber/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "statusPageId": true,
    "createdByUserId": true,
    "subscriberEmail": true,
    "subscriberWebhook": true
  }
}

Ответ

{
  "_id": "377d7890-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
  "subscriberEmail": "subscriber@example.com",
  "subscriberWebhook": "https://example.com/webhook"
}
POST/api/status-page-subscriber/count

Количество

Возвращает количество ваших объектов «Status Page Subscriber».

Необязательное тело запроса

Запрос количества

POST
/api/status-page-subscriber/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "microsoftTeamsWorkspaceName": "Example microsoft teams workspace name"
  }
}

Ответ

{
  "count": 107
}
POST/api/status-page-subscriber

Создать Status Page Subscriber

Создаёт новый объект.

Запрос создания

POST
/api/status-page-subscriber
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
    "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
    "subscriberEmail": "subscriber@example.com",
    "subscriberWebhook": "https://example.com/webhook"
  }
}

Ответ

{
  "_id": "377d7890-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
  "subscriberEmail": "subscriber@example.com",
  "subscriberWebhook": "https://example.com/webhook"
}
PUT/api/status-page-subscriber/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/status-page-subscriber/:id/update-item
GET/api/status-page-subscriber/:id/update-item

Запрос обновления

PUT
/api/status-page-subscriber/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "subscriberEmail": "subscriber@example.com",
    "subscriberWebhook": "https://example.com/webhook",
    "internalNote": "Example notes content"
  }
}

Ответ

{}
DELETE/api/status-page-subscriber/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/status-page-subscriber/:id/delete-item
GET/api/status-page-subscriber/:id/delete-item

Запрос удаления

DELETE
/api/status-page-subscriber/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Status Page Subscriber

  • Project Owner
  • Project Admin
  • Project Member
  • Read Status Page Subscriber
  • Read All Project Resources

Права на создание

Нужны для создания Status Page Subscriber

  • Project Owner
  • Project Admin
  • Project Member
  • Create Status Page Subscriber
  • Public

Права на обновление

Нужны для обновления Status Page Subscriber

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Status Page Subscriber

Права на удаление

Нужны для удаления Status Page Subscriber

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Status Page Subscriber