API-referentie voor routeringsregels

Mogelijke waarden voor velden

Type actie

Waarde	Beschrijving
`NOTIFY_TEAM`	Waarschuw een bepaald team
`NOTIFY_WORKSPACE_MEMBER`	Waarschuw een bepaald lid van de workspace
`NOTIFY_CURRENT_ON_CALL_USER`	Waarschuw wie nu oproepdienst heeft
`NOTIFY_NEXT_ON_CALL_USER`	Waarschuw wie hierna oproepdienst heeft
`NOTIFY_ALL_ON_CALL_MEMBERS`	Waarschuw alle leden die nu oproepdienst hebben

Type voorwaarde

Waarde	Beschrijving
`IMPACT`	Controleert de invloed van een gebeurtenis
`TITLE`	Controleert de titel van een gebeurtenis
`DESCRIPTION`	Controleert de beschrijving van een gebeurtenis
`AFFECTED_COMPONENTS`	Controleert de getroffen componenten van een gebeurtenis

Types vergelijking

Waarde	Beschrijving
`EQUALS`	Controleert of de waarde gelijk is
`NOT_EQUALS`	Controleert of de waarde niet gelijk is
`IS_EMPTY`	Controleert of de waarde leeg is
`NOT_EMPTY`	Controleert of de waarde niet leeg is
`GREATER_THAN`	Controleert of de waarde groter is dan
`GREATER_THAN_OR_EQUALS`	Controleert of de waarde groter dan of gelijk aan is
`LESS_THAN`	Controleert of de waarde kleiner is dan
`LESS_THAN_OR_EQUALS`	Controleert of de waarde kleiner dan of gelijk aan is
`CONTAINS`	Controleert of de waarde een bepaalde tekenreeks bevat
`NOT_CONTAINS`	Controleert of de waarde een bepaalde tekenreeks niet bevat
`HAS_KEY`	Controleert of een object een bepaalde sleutel heeft
`NOT_HAS_KEY`	Controleert of een object een bepaalde sleutel niet heeft
`HAS_VALUE`	Controleert of een object een bepaalde waarde heeft
`NOT_HAS_VALUE`	Controleert of een object een bepaalde waarde niet heeft
`IS_NULL`	Controleert of de waarde null is
`NOT_NULL`	Controleert of de waarde niet null is
`STARTS_WITH`	Controleert of de waarde met een bepaalde tekenreeks begint
`ENDS_WITH`	Controleert of de waarde op een bepaalde tekenreeks eindigt

Routeringsregels ophalen

Endpoint:

GET /:page_id/routing-rules

Voorbeeldverzoek

GET /1/routing-rules

Voorbeeldrespons

{
  "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
    }
  ]
}

Een routeringsregel aanmaken

Endpoint:

POST /routing-rules

Houd er rekening mee dat targetId in acties een e-mailadres van een lid van de workspace of een team-id kan zijn, afhankelijk van het type actie.

Voorbeeldverzoek

{
  "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"
}

Voorbeeldrespons

{
  "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."
}

Een routeringsregel bijwerken

Endpoint:

PUT /routing-rules/:id

Voorbeeldverzoek

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"
}

Voorbeeldrespons

{
  "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"
}

Een routeringsregel verwijderen

Endpoint:

DELETE /routing-rules/:id

Voorbeeldverzoek

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

Voorbeeldrespons

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