openapi: 3.0.1
info:
  title: HubSpot Meta Origins
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
- url: https://api.hubapi.com
tags:
- name: Advanced
- name: Basic
paths:
  /meta/network-origins/2026-09/ip-ranges:
    get:
      tags:
      - Basic
      operationId: get-/meta/network-origins/2026-09/ip-ranges_/meta/network-origins/2026-09-beta/ip-ranges
      parameters:
      - name: direction
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - INGRESS
            - EGRESS
      - name: service
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - EMAIL
            - API
            - DNS
            - WEB_SCRAPING
            - TEST_SERVICE
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseIpRangeNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
  /meta/network-origins/2026-09/ip-ranges/simple:
    get:
      tags:
      - Basic
      operationId: get-/meta/network-origins/2026-09/ip-ranges/simple_/meta/network-origins/2026-09-beta/ip-ranges/simple
      parameters:
      - name: direction
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - INGRESS
            - EGRESS
      - name: service
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - EMAIL
            - API
            - DNS
            - WEB_SCRAPING
            - TEST_SERVICE
      responses:
        '200':
          description: successful operation
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          $ref: '#/components/responses/Error'
  /meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}:
    get:
      tags:
      - Basic
      operationId: get-/meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}_/meta/network-origins/2026-09-beta/ip-ranges/webhook-subscriptions/{appId}
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          pattern: .+
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWebhookSubscriptionNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - origins.ip_ranges.webhook.read
      - oauth2:
        - origins.ip_ranges.webhook.write
    post:
      tags:
      - Basic
      operationId: post-/meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}_/meta/network-origins/2026-09-beta/ip-ranges/webhook-subscriptions/{appId}
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          pattern: .+
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriptionRequest'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - origins.ip_ranges.webhook.write
  /meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}/{subscription-id}:
    delete:
      tags:
      - Basic
      operationId: delete-/meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}/{subscription-id}_/meta/network-origins/2026-09-beta/ip-ranges/webhook-subscriptions/{appId}/{subscription-id}
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          pattern: .+
          type: string
      - name: subscription-id
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - origins.ip_ranges.webhook.write
  /meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}/{subscription-id}/test:
    post:
      tags:
      - Advanced
      operationId: post-/meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}/{subscription-id}/test_/meta/network-origins/2026-09-beta/ip-ranges/webhook-subscriptions/{appId}/{subscription-id}/test
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          pattern: .+
          type: string
      - name: subscription-id
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - origins.ip_ranges.webhook.write
components:
  schemas:
    CollectionResponseIpRangeNoPaging:
      required:
      - results
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/IpRange'
    CollectionResponseWebhookSubscriptionNoPaging:
      required:
      - results
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/WebhookSubscription'
    Error:
      required:
      - category
      - correlationId
      - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}'
        correlationId:
          type: string
          description: A unique identifier for the request. Include this value with any error reports
            or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: A map of link names to associated URIs containing documentation about the error
            or recommended remediation steps
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
          example: An error occurred
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: Represents an error response returned by the API when an operation fails. This component
        is used in various endpoints to provide detailed information about the error encountered.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
      - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: Represents detailed information about an error that occurred in the API. This component
        is used to provide additional context and specifics about errors, typically as part of an error
        response.
    IpRange:
      required:
      - cidr
      - description
      - direction
      - service
      type: object
      properties:
        cidr:
          type: string
          description: The CIDR notation representing the IP range.
        description:
          type: string
          description: A description of the IP range.
        direction:
          type: string
          description: The direction of the IP traffic, which can be INGRESS or EGRESS.
          enum:
          - EGRESS
          - INGRESS
        service:
          type: string
          description: The service associated with the IP range, such as EMAIL, API, DNS, or WEB_SCRAPING.
          enum:
          - API
          - DNS
          - EMAIL
          - TEST_SERVICE
          - WEB_SCRAPING
    WebhookSubscription:
      required:
      - appId
      - createdAt
      - id
      - portalId
      - updatedAt
      - webhookUrl
      type: object
      properties:
        appId:
          type: integer
          format: int32
        createdAt:
          type: integer
          format: int64
        createdByUserId:
          type: integer
          format: int32
        id:
          type: integer
          format: int64
        portalId:
          type: integer
          format: int32
        updatedAt:
          type: integer
          format: int64
        webhookUrl:
          type: string
    WebhookSubscriptionRequest:
      required:
      - webhookUrl
      type: object
      properties:
        webhookUrl:
          type: string
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    developer_hapikey:
      type: apiKey
      name: hapikey
      in: query
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            origins.ip_ranges.webhook.read: ''
            origins.ip_ranges.webhook.write: ''
    private_apps:
      type: apiKey
      name: private-app
      in: header
    private_apps_legacy:
      type: apiKey
      name: private-app-legacy
      in: header
x-hubspot-product-tier-requirements:
  marketing: FREE
  sales: FREE
  service: FREE
  cms: FREE
  commerce: FREE
  crmHub: FREE
  dataHub: FREE