Basic

Update webhook settings

Update webhook settings for the specified app.

put/webhooks/v3/{appId}/settings

Path parameters

appIdinteger required

The ID of the target app.

Request body

targetUrlstring required

A publicly available URL for HubSpot to call where event payloads will be delivered. This URL must be accessible to receive event notifications.

Example request

{
  "targetUrl": "https://www.example.com/hubspot/target",
  "throttling": {
    "maxConcurrentRequests": 10,
    "period": "SECONDLY"
  }
}

Response

successful operation

createdAtstring date-time required

When this subscription was created, formatted as a date-time string.

targetUrlstring required

A publicly available URL for HubSpot to call where event payloads will be delivered.

updatedAtstring date-time

When this subscription was last updated, formatted as a date-time string.

Example response

{
  "createdAt": "2020-01-24T16:27:59Z",
  "targetUrl": "https://www.example.com/hubspot/target",
  "throttling": {
    "maxConcurrentRequests": 10,
    "period": "SECONDLY"
  },
  "updatedAt": "2020-01-24T16:32:43Z"
}