{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kit Accounts Webhooks API",
    "version": "4.0"
  },
  "items": [
    {
      "info": {
        "name": "Webhooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List webhooks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kit.com/v4/webhooks",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "To fetch next page of results, use `?after=<end_cursor>`"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "To fetch previous page of results, use `?before=<start_cursor>`"
              },
              {
                "name": "include_total_count",
                "value": "false",
                "type": "query",
                "description": "Set to `true` to include the `total_count` in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Default 500, maximum 1000."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Webhooks are automations that will receive subscriber data when a subscriber event is triggered, such as when a subscriber completes a sequence.<br/><br/>When a webhook is triggered, a `POST` request will be made to your URL with a JSON payload."
        },
        {
          "info": {
            "name": "Create a webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kit.com/v4/webhooks",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Available event types:<br/>- `subscriber.subscriber_activate`<br/>- `subscriber.subscriber_unsubscribe`<br/>- `subscriber.subscriber_bounce`<br/>- `subscriber.subscriber_complain`<br/>- `subscriber.form_subscribe`, required parameter `form_id` [Integer]<br/>- `subscriber.course_subscribe`, required parameter `sequence_id` [Integer]<br/>- `subscriber.course_complete`, required parameter `sequence_id` [Integer]<br/>- `subscriber.link_click`, required parameter `initiator_value` [String] as a link "
        },
        {
          "info": {
            "name": "Delete a webhook",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.kit.com/v4/webhooks/:id",
            "params": [
              {
                "name": "id",
                "value": "31",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a webhook"
        }
      ]
    }
  ],
  "bundled": true
}