{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_advertisement_opportunities subpackage_webhooks API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_webhooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List webhooks <Badge intent=\"info\" minimal outlined>OAuth Scope: webhooks:read</Badge>",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/webhooks",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10."
              }
            ]
          },
          "docs": "Retrieve all webhooks belonging to a specific publication."
        },
        {
          "info": {
            "name": "Create a webhook <Badge intent=\"info\" minimal outlined>OAuth Scope: webhooks:write</Badge>",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/webhooks",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new webhook for a given publication."
        },
        {
          "info": {
            "name": "Get webhook <Badge intent=\"info\" minimal outlined>OAuth Scope: webhooks:read</Badge>",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/webhooks/:endpointId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "endpointId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the webhook object"
              }
            ]
          },
          "docs": "Retrieve a specific webhook belonging to a publication."
        },
        {
          "info": {
            "name": "Update webhook <Badge intent=\"info\" minimal outlined>OAuth Scope: webhooks:write</Badge>",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/webhooks/:endpointId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "endpointId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the webhook object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a webhook subscription for a publication."
        },
        {
          "info": {
            "name": "Delete a webhook <Badge intent=\"info\" minimal outlined>OAuth Scope: webhooks:write</Badge>",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/webhooks/:endpointId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "endpointId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the webhook object"
              }
            ]
          },
          "docs": "Delete a webhook subscription from a publication."
        }
      ]
    }
  ],
  "bundled": true
}