Tutorial NerdGraph: destinos de inteligência aplicada

Além de gerenciar seus destinos de inteligência aplicada na interface, você pode utilizar nossa API NerdGraph.

Dica

Para obter ajuda para começar a usar o NerdGraph, consulte Introdução ao NerdGraph.

Listar e filtrar destinos

A consulta destinations permite paginar todos os seus destinos por conta. Também permite algumas funcionalidades de filtragem.

Aqui está um exemplo:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations {
          entities {
            id
            name
          }
          error {
            details
          }
        }
      }
    }
  }
}

Para paginar seus destinos, você deve solicitar o campo nextCursor na sua consulta inicial.

Com a paginação do cursor, você continua fazendo uma solicitação por meio do conjunto de resultados até que nextCursor retornado da resposta retorne vazio. Isso significa que você chegou ao fim dos seus resultados.

Aqui está um exemplo:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
          }
          totalCount
        }
      }
    }
  }
}

O código acima retorna um conjunto de resultados como este:

{
  "data": {
    "actor": {
      "account": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name"
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name"
              }
              // ... more destinations here in reality
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

Portanto, em sua solicitação subsequente, forneça o cursor assim, até que ele fique vazio:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
          }
          totalCount
        }
      }
    }
  }
}

A API permite consultar o destino por nome. O filtro name retorna correspondências exatas e parciais. Não faz distinção entre maiúsculas e minúsculas. Isso retornará apenas as informações dos destinos que correspondem ao nome fornecido.

Neste exemplo, queremos encontrar destinos com "DevOps" no nome:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { name: "DevOps" }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

A API permite consultar por ID de destino:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { id: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

A API permite consultar por tipo de destino. A consulta a seguir retornará todos os destinos de email na conta escolhida:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { type: EMAIL }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

Crie um destino

Para criar um destino, diferentes entradas devem ser fornecidas para cada tipo de destino. Uma propriedade two_way_integration opcional está disponível para integrações que permitem integração bidirecional.

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: JIRA,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_EMAIL,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "url",
        value: "https://YOUR_INSTANCE.atlassian.net"
      },
      {
        key: "two_way_integration",
        value: "true"
      }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: SERVICE_NOW,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_EMAIL,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "url",
        value: "https://YOUR_INSTANCE.service-now.com"
      },
     {
       key: "two_way_integration",
       value: "true"
     }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

Neste exemplo, auth é opcional, dependendo do serviço que está sendo integrado.

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: WEBHOOK,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_EMAIL,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "url",
        value: YOUR_WEBHOOK
      },
     {
       key: "two_way_integration",
       value: "true"
     }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: EVENT_BRIDGE,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_IAM_USER,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "AWSAccountId",
        value:  YOUR_AWS_ACCOUNT_ID
      },
      {
        key: "AWSRegion",
        value:  YOUR_AWS_REGION
      }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

PagerDuty possui dois tipos de integração, nível de serviço e nível de conta. Para obter mais informações, consulte os documentos de integração do PagerDuty.

Nível de serviço:

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: PAGERDUTY_SERVICE_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_INTEGRATION_TOKEN, prefix: "Token token=" }
      }
      properties: []
    }
  ) {
    destination {
      id
      name
    }
  }
}

Nível da conta:

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: PAGERDUTY_ACCOUNT_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_API_KEY, prefix: "Token token=" }
      }
      properties: [{ key: "two_way_integration", value: "true" }]
    }
  ) {
    destination {
      id
      name
    }
  }
}

Atualizar um destino

Ao atualizar um destino, observe que não é necessário fornecer todos os atributos do destino. Por exemplo, você só precisa fornecer o nome se pretende apenas atualizá-lo:

mutation {
  aiNotificationsUpdateDestination(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_destination_ID
    destination: { name: "Updated destination Name" }
  ) {
    destination {
      id
      name
    }
  }
}

Testando um destino

Você pode testar destinos por meio da API NerdGraph. Isso pode ser feito antes ou depois de criar o destino.

mutation {
  aiNotificationsTestDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    error {
      details
    }
    details
    result
  }
}

mutation {
  aiNotificationsTestDestinationById(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_DESTINATION_ID
  ) {
    error {
      details
    }
    details
    result
  }
}

Excluir um destino

Você pode excluir destinos por meio da API NerdGraph.

mutation {
  aiNotificationsDeleteDestination(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_DESTINATION_ID
  ) {
    ids
    error {
      details
    }
  }
}

Importante

Se você receber uma mensagem de falha informando Entity type channel is in use, será necessário identificar os canais usados pelo destino e excluí-los antes de continuar. Para fazer isso, primeiro encontre todos os canais associados ao destino e, em seguida, exclua cada canal individualmente.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        channels(filters: { destinationId: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

mutation {
  aiNotificationsDeleteChannel(
    accountId: YOUR_ACCOUNT_ID
    channelId: YOUR_CHANNEL_ID
  ) {
    ids
    error {
      details
    }
  }
}

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: destinos de inteligência aplicada

Dica

Listar e filtrar destinos

Listando todos os destinos de uma conta

Paginando destinos com paginação de cursor

Encontre todos os destinos por nome

Encontre o destino por ID

Encontre todos os destinos por tipo

Crie um destino

Jira Atlassiana

ServiceNow (Incident-Management)

Slack

Webhook

E-mail

AWS EventBridge

PagerDuty

Atualizar um destino

Testando um destino

Excluir um destino

Importante

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: destinos de inteligência aplicada

Dica

Listar e filtrar destinos .css-21sua1{background:none;border:none;width:0;padding:0;}

Paginando destinos com paginação de cursor

Encontre todos os destinos por nome

Encontre o destino por ID

Encontre todos os destinos por tipo

Crie um destino

Jira Atlassiana

ServiceNow (Incident-Management)

Slack

Webhook

E-mail

AWS EventBridge

PagerDuty

Atualizar um destino

Testando um destino

Excluir um destino

Importante

Listar e filtrar destinos