Alterar um webhook (rotacionar o secret, mudar eventos…)
Endpoint PATCH /webhooks/{id} da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.
bearerAuthAutorizaçãoBearer <token>Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.
id*stringuuidorg_id?stringSomente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.
uuidapplication/json- body
url?stringurisecret?stringRotaciona o segredo de assinatura
16 <= length <= 256name?stringevents?array<>|nullmin_severity?string"critical""high""medium""low""info"active?booleanWebhook
application/json- response
id?stringuuidorg_id?stringuuidstore_id?|null = toda a organização
uuidtype?string"webhook""slack""teams"name?stringurl?|uriformat?string"json""slack""teams"has_secret?booleanevents?array<>|null = todos os eventos
min_severity?string"critical""high""medium""low""info"active?booleanlast_used_at?|date-timecreated_at?stringdate-timeupdated_at?stringdate-timecurl -X PATCH "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "events": null, "min_severity": "medium", "active": true }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0", "type": "webhook", "name": "string", "url": "http://example.com", "format": "json", "has_secret": true, "events": [ "alert.created" ], "min_severity": "critical", "active": true, "last_used_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Enviar um evento de teste POST
Endpoint POST /webhooks/{id}/test da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.
Evento de saída entregue na URL do seu webhook Webhook
Formato do evento que o Proteside envia para a URL do seu webhook: campos, tipos e exemplo de corpo.