SysAid Webhooks API

The Webhooks API from SysAid — 5 operation(s) for webhooks.

OpenAPI Specification

sysaid-webhooks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: SysAid REST ActionItems Webhooks API
  description: 'REST API for SysAid ITSM. Manage service records (incidents, requests, problems, changes), users (agents and end users), groups, companies, assets, configuration items (CIs), templates, attachments, webhooks (beta), and license manager records. Authentication uses Client Credentials to mint short-lived application access tokens. Source: https://developers.sysaid.com/'
  version: '1.0'
  contact:
    name: SysAid
    url: https://developers.sysaid.com/
servers:
- url: https://your-account.sysaidit.com
  description: SysAid tenant base URL (replace your-account)
security:
- BearerAuth: []
tags:
- name: Webhooks
paths:
  /createwebhook:
    post:
      tags:
      - Webhooks
      summary: Create webhook subscription
      operationId: createWebhook
      responses:
        '201':
          description: Created
  /getwebhooksbyaccountid:
    get:
      tags:
      - Webhooks
      summary: List webhooks
      operationId: getWebhooksByAccountId
      responses:
        '200':
          description: OK
  /simulatewebhookevent:
    post:
      tags:
      - Webhooks
      summary: Test webhook
      operationId: simulateWebhookEvent
      responses:
        '200':
          description: OK
  /getwebhooksubscriberbyid:
    get:
      tags:
      - Webhooks
      summary: Retrieve webhook details
      operationId: getWebhookSubscriberById
      responses:
        '200':
          description: OK
  /deletewebhooksubscriberbyid:
    delete:
      tags:
      - Webhooks
      summary: Remove webhook
      operationId: deleteWebhookSubscriberById
      responses:
        '204':
          description: Deleted
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Client Credentials grant: exchange client_id and client_secret at /generateaccesstoken for a short-lived access token (default 24h), then pass as "Authorization: Bearer <token>".'