HeavyBid Pre-Construction

Gets all webhooks

List of all webhooks that belong to the calling client ID.

Securitybearer
Request
path Parameters
businessUnitId
required
string
Responses
200

Success.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

get/api/v1/precon/{businessUnitId}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a subscription for an event
This endpoint takes in a callback URL, and a list of event types that you would like to receive updates for. During this request, HCSS will make a GET request to your callback URL with a query parameter called "challenge". Your endpoint must return a 200 OK with the challenge in the response. Once your callback URL has successfully responded to the challenge, you will begin to receive POST requests to the same URL. Information regarding the shape of these POST requests can be seen in the "Callbacks" section below.


Securitybearer 
Request 
path Parameters
businessUnitId
required
string
 
Request Body schema: application/json
required
url
string
The callback URL. This is where the webhook notifications will be sent.


 
eventTypes
Array of strings (PreConEventType) 
The available event types for subscription. You can subscribe to either one or all of the events.


Items Enum: "ProjectCreated" "ProjectChanged" "ProjectDeleted" "SchemaChanged"  
secretKey
string
The optional secret key. This key is used to calculate hash of the response payload and included in the header.
If not provided, HCSS will generate a random key and include it in the response.


 
Responses 
200
Success.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


Callbacks 
postwww.myAmazingWebhook.com/precon/projectUpdates
postwww.myAmazingWebhook.com/precon/schemaUpdates
post/api/v1/precon/{businessUnitId}
Request samples 
application/json
{
  • "url": "https://My.WebhookSite.com",
  • "eventTypes": [
    ],
  • "secretKey": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols="
}
Response samples 
application/json
{
  • "secretKey": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols="
}
Callback payload samples 
application/json
{}
Updates a subscription for an event
This endpoint takes in a callback URL, and a list of event types that you would like to receive updates for. During this request, HCSS will make a GET request to your callback URL with a query parameter called "challenge". Your endpoint must return a 200 OK with the challenge in the response. Once your callback URL has successfully responded to the challenge, you will begin to receive POST requests to the same URL. Information regarding the shape of these POST requests can be seen in the "Callbacks" section below.


Securitybearer 
Request 
path Parameters
businessUnitId
required
string
 
Request Body schema: application/json
required
url
string
The callback URL. This is where the webhook notifications will be sent.


 
eventTypes
Array of strings (PreConEventType) 
The available event types for subscription. You can subscribe to either one or all of the events.


Items Enum: "ProjectCreated" "ProjectChanged" "ProjectDeleted" "SchemaChanged"  
secretKey
string
The optional secret key. This key is used to calculate hash of the response payload and included in the header.
If not provided, HCSS will generate a random key and include it in the response.


 
Responses 
200
Success.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


Callbacks 
postwww.myAmazingWebhook.com/precon/projectUpdates
postwww.myAmazingWebhook.com/precon/schemaUpdates
put/api/v1/precon/{businessUnitId}
Request samples 
application/json
{
  • "url": "https://My.WebhookSite.com",
  • "eventTypes": [
    ],
  • "secretKey": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols="
}
Response samples 
application/json
{
  • "secretKey": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols="
}
Callback payload samples 
application/json
{}
Delete a subscription
Delete a subscription


Securitybearer 
Request 
path Parameters
businessUnitId
required
string
 
query Parameters
url
string
 
Responses 
200
Success.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


delete/api/v1/precon/{businessUnitId}
Request samples