HubSpot: Ip ranges schemas

← Ip ranges operations · All schemas

Create webhook subscription — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
webhookUrl	string	Required within parent	The URL to which webhook events will be sent. This must be a valid URL in string format.

Create webhook subscription — response body

Field	Type	Presence	Description and constraints
$	object	Root
appId	JSON	Required within parent
appId (anyOf 1)	integer	Alternative	The unique identifier of the application that owns the webhook subscription. It is an integer. Format: int32
appId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	The timestamp when the webhook subscription was created, represented as an integer in int64 format. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdByUserId	JSON	Optional
createdByUserId (anyOf 1)	integer	Alternative	The unique identifier of the user who created the webhook subscription. It is an integer. Format: int32
createdByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier of the webhook subscription. It is an integer formatted as int64. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
portalId	JSON	Required within parent
portalId (anyOf 1)	integer	Alternative	The unique identifier of the HubSpot portal associated with the webhook subscription. It is an integer. Format: int32
portalId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	The timestamp when the webhook subscription was last updated, represented as an integer in int64 format. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
webhookUrl	string	Required within parent	The URL to which the webhook events will be sent. It is a string.

Retrieve IP Ranges — ip Ranges get Origins — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of IpRange objects, each representing a specific IP range with associated metadata such as CIDR, direction, service, and description.
results[]	Model	Each item	Expand Retrieve IP Ranges — ip Ranges get Origins — response body — results item

Referenced models: Retrieve IP Ranges — ip Ranges get Origins — response body — results item

Retrieve IP Ranges — ip Ranges get Origins — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
cidr	string	Required within parent	The CIDR notation representing the IP range.
description	string	Required within parent	A description of the IP range.
direction	string	Required within parent	The direction of the IP traffic, which can be INGRESS or EGRESS. Known values: EGRESS, INGRESS
service	string	Required within parent	The service associated with the IP range, such as EMAIL, API, DNS, or WEB_SCRAPING. Known values: API, DNS, EMAIL, TEST_SERVICE, WEB_SCRAPING

Retrieve subscriptions — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of webhook subscriptions. Each item in the array is a WebhookSubscription object.
results[]	Model	Each item	Expand Create webhook subscription — response body

Referenced models: Create webhook subscription — response body