{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Webhook API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Webhook",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Webhooks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/webhooks"
          },
          "docs": "This API lists all webhooks configured in your help desk."
        },
        {
          "info": {
            "name": "Create webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/webhooks",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a webhook in your help desk. When the API is invoked, a validation GET request is sent to the subscription URL. That subscription end-point must return a 200 OK message to confirm the subscription. If the 200 OK message is not received, a validation POST request is initiated to the subscription URL. Failure to receive a 200 OK message will result in the failure of webhook creation."
        },
        {
          "info": {
            "name": "Get webhook",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches a single webhook from your help desk."
        },
        {
          "info": {
            "name": "Update Webhook",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates the details of an existing webhook. When the webhook's URL is altered, a validation GET request is sent to the new URL. If the 200 OK message is not received, a validation POST request is initiated."
        },
        {
          "info": {
            "name": "Delete Webhook",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API deletes an existing webhook. After this API is executed, the URL in the webhook stops receiving event information."
        }
      ]
    }
  ],
  "bundled": true
}