Reference API pro pravidla směrování

Možné hodnoty polí

Typ akce

Hodnota	Popis
`NOTIFY_TEAM`	Upozornit konkrétní tým
`NOTIFY_WORKSPACE_MEMBER`	Upozornit konkrétního člena workspace
`NOTIFY_CURRENT_ON_CALL_USER`	Upozornit aktuálního uživatele v pohotovosti
`NOTIFY_NEXT_ON_CALL_USER`	Upozornit dalšího uživatele v pohotovosti
`NOTIFY_ALL_ON_CALL_MEMBERS`	Upozornit všechny členy právě v pohotovosti

Typ podmínky

Hodnota	Popis
`IMPACT`	Ověřuje dopad události
`TITLE`	Ověřuje název události
`DESCRIPTION`	Ověřuje popis události
`AFFECTED_COMPONENTS`	Ověřuje zasažené komponenty události

Typy porovnání

Hodnota	Popis
`EQUALS`	Kontroluje, jestli se hodnota rovná
`NOT_EQUALS`	Kontroluje, jestli se hodnota nerovná
`IS_EMPTY`	Kontroluje, jestli je hodnota prázdná
`NOT_EMPTY`	Kontroluje, jestli hodnota není prázdná
`GREATER_THAN`	Kontroluje, jestli je hodnota větší
`GREATER_THAN_OR_EQUALS`	Kontroluje, jestli je hodnota větší nebo rovna
`LESS_THAN`	Kontroluje, jestli je hodnota menší
`LESS_THAN_OR_EQUALS`	Kontroluje, jestli je hodnota menší nebo rovna
`CONTAINS`	Kontroluje, jestli hodnota obsahuje daný podřetězec
`NOT_CONTAINS`	Kontroluje, jestli hodnota podřetězec neobsahuje
`HAS_KEY`	Kontroluje, jestli má objekt daný klíč
`NOT_HAS_KEY`	Kontroluje, jestli objekt daný klíč nemá
`HAS_VALUE`	Kontroluje, jestli má objekt danou hodnotu
`NOT_HAS_VALUE`	Kontroluje, jestli objekt danou hodnotu nemá
`IS_NULL`	Kontroluje, jestli je hodnota null
`NOT_NULL`	Kontroluje, jestli hodnota není null
`STARTS_WITH`	Kontroluje, jestli hodnota daným podřetězcem začíná
`ENDS_WITH`	Kontroluje, jestli hodnota daným podřetězcem končí

Získání pravidel směrování

Endpoint:

GET /:page_id/routing-rules

Ukázkový požadavek

GET /1/routing-rules

Ukázková odpověď

{
  "routingRules": [
    {
      "id": "1",
      "siteId": "pageId",
      "assertions": [
        {
          "id": "1",
          "routingRuleId": "1",
          "type": "TITLE",
          "comparison": "CONTAINS",
          "value": "value1"
        },
        {
          "id": "2",
          "routingRuleId": "1",
          "type": "TITLE",
          "comparison": "CONTAINS",
          "value": "value2"
        }
      ],
      "actions": [
        {
          "id": "1",
          "routingRuleId": "1",
          "type": "NOTIFY_WORKSPACE_MEMBER",
          "targetId": "value1"
        },
        {
          "id": "2",
          "routingRuleId": "1",
          "type": "NOTIFY_WORKSPACE_MEMBER",
          "targetId": "member@platform.com"
        }
      ],
      "createdAt": "2021-09-29T00:00:00.000Z",
      "updatedAt": "2021-09-29T00:00:00.000Z",
      "order": 1
    }
  ]
}

Vytvoření pravidla směrování

Endpoint:

POST /routing-rules

Pamatujte, že targetId v akcích může být e-mail člena workspace nebo id týmu podle typu akce.

Ukázkový požadavek

{
  "routingRule": {
    "assertions": [
      {
        "id": "1",
        "routingRuleId": "1",
        "type": "TITLE",
        "comparison": "CONTAINS",
        "value": "value1"
      },
      {
        "id": "2",
        "routingRuleId": "1",
        "type": "TITLE",
        "comparison": "CONTAINS",
        "value": "value2"
      }
    ],
    "actions": [
      {
        "id": "1",
        "routingRuleId": "1",
        "type": "NOTIFY_WORKSPACE_MEMBER",
        "targetId": "member2@platform.com"
      },
      {
        "id": "2",
        "routingRuleId": "1",
        "type": "NOTIFY_WORKSPACE_MEMBER",
        "targetId": "member@platform.com"
      }
    ],
    "order": 1,
    "siteId": "site-id-1"
  },
  "message": "Routing rule updated successfully"
}

Ukázková odpověď

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "order": 1,
    "siteId": "site123",
    "updatedAt": "2021-09-01T12:00:00Z",
    "createdAt": "2021-09-01T12:00:00Z"
  },
  "message": "Routing rule created successfully."
}

Aktualizace pravidla směrování

Endpoint:

PUT /routing-rules/:id

Ukázkový požadavek

PUT /routing-rules/routing-rule-id-1

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "assertions": [
      {
        "id": "assertion-id-1",
        "routingRuleId": "routing-rule-id-1",
        "comparison": "CONTAINS",
        "value": "Issue With X",
        "type": "TITLE"
      }
    ],
    "order": 1,
    "siteId": "site-id-1",
    "updatedAt": "2021-09-01T12:00:00Z",
    "createdAt": "2021-05-01T12:00:00Z"
  },
  "message": "Routing rule updated successfully"
}

Ukázková odpověď

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "assertions": [
      {
        "id": "assertion-id-1",
        "routingRuleId": "routing-rule-id-1",
        "comparison": "CONTAINS",
        "value": "Issue With X",
        "type": "TITLE"
      }
    ],
    "order": 1,
    "siteId": "site-id-1",
    "updatedAt": "2024-08-09T12:00:00Z",
    "createdAt": "2021-05-01T12:00:00Z"
  },
  "message": "Routing rule updated successfully"
}

Smazání pravidla směrování

Endpoint:

DELETE /routing-rules/:id

Ukázkový požadavek

DELETE /routing-rules/routing-rule-id-1

Ukázková odpověď

{
  "message": "Routing rule deleted successfully."
}