Listar plantões no PagerDuty, por uma API
Lista quem está de plantão, uma entrada por usuário, política de escalonamento e nível, com a escala quando o turno vem de uma. Sem since e until, retorna os plantões de agora. Pagine com limit e offset enquanto more for true.
- Identificador
- pagerduty_list_oncalls
A chamada
POST https://connect.reportei.com/api/tools/pagerduty_list_oncalls/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"since": "<since>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| since | string | Não | Start of the range, in ISO 8601. Shifts that overlap the range are returned, up to 90 days ahead. |
| until | string | Não | End of the range, in ISO 8601. Not before since. |
| earliest | boolean | Não | Set to true to return only the next on-call of each combination of escalation policy, level and user. |
| time_zone | string | Não | IANA time zone used to render the timestamps, for example America/Sao_Paulo. Defaults to the time zone of the account. |
| limit | integer | Não | Entries per page, up to 100. |
| offset | integer | Não | Number of entries to skip. |
| total | boolean | Não | Set to true to fill the total field of the response, which is slower. |
Conexões possíveis
O seu cliente conecta a conta do PagerDuty uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/pagerduty_list_oncalls. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do PagerDuty
- Listar incidentesGETLista os incidentes da conta criados no último mês, ou no intervalo de since e until. Não há filtro por status, serviço ou responsável aqui, então leia status, service e assignments em cada item. Pagine com limit e offset enquanto more for true.
- Obter incidenteGETRetorna um incidente com status, urgência, prioridade, serviço, atribuições, reconhecimentos e política de escalonamento.
- Criar incidentePOSTCria um incidente em um serviço, o que notifica a política de escalonamento do serviço ou os usuários em assignments. Precisa de type, title e service. Envie assignments ou escalation_policy, nunca os dois. Um incidente que o usuário atribui a si mesmo começa reconhecido, sem notificá-lo.
- Atualizar incidentePUTReconhece, resolve, reatribui ou escala um incidente, ou muda seu título, urgência, prioridade ou serviço. Envie type e só os campos a mudar. Reatribuir ou escalar notifica os novos responsáveis, e definir status em um incidente resolvido o reabre.
- Listar notas do incidenteGETLista as notas de um incidente, cada uma com seu conteúdo, autor e hora de criação.
- Criar nota no incidentePOSTAdiciona uma nota a um incidente, assinada pelo usuário da conexão. Um incidente comporta até 2000 notas.
- Listar entradas de log do incidenteGETLista a linha do tempo de um incidente: acionamentos, notificações, reconhecimentos, atribuições, escalonamentos, notas e resolução, cada um com o agente e a hora. Pagine com limit e offset enquanto more for true.
- Listar serviçosGETLista os serviços da conta, cada um com id, nome, status e política de escalonamento. O id é o que Create incident e Update incident pedem. Pagine com limit e offset enquanto more for true.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
