Tackle.io Webhooks API
Operations for Webhooks
Tackle.io Webhooks API is one of 28 APIs that Tackle.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 7 operations across 4 paths, and defines 76 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://contracts.tackle.io.
7 operations
4 paths
76 schemas
2 DELETE3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tackle.io Webhooks API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (tackleJwt).
By default, every request must be authenticated.
tackleJwt— Tackle-issued JWT (interactive user or MTM token).
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Webhooks 7
Operations for Webhooks
POST
/v1/webhooks
Create or Update a Webhook
GET
/v1/webhooks
Get All Webhooks for Vendor
POST
/v1/webhooks/test
Test a Webhook
DELETE
/v1/webhooks/vendor
Delete a Vendor-Level Webhook
GET
/v1/webhooks/vendor
Get a Vendor-Level Webhook
DELETE
/v1/webhooks/product/{productid}
Delete a Product-Level Webhook
GET
/v1/webhooks/product/{productid}
Get a Product-Level Webhook
Schemas 76
The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are WebhookTestExecutionResponseRequestPO (17 properties), GcpEntitlement (17 properties), AzurePrivateOfferCallback (15 properties), AWSNewOrderCallback (14 properties). Each schema is shown below with its type and property counts.
AwsProductId
string
AWS Product Code
WebhookTestExecutionResponseRequestPO
object
17 properties
Error
object
4 properties
3 required
RedHatCustomerId
string
Red Hat Customer Id
WebhooksUpsertResponse
object
2 properties
1 required
VendorId
string
Tackle issued identifier for the Vendor
AwsCloud
string
AWS Cloud
WebhooksRequestFilters
An object with either a valid productid or supportedclouds
WebhooksGetAllResponseObject
object
4 properties
AzureCloud
string
Azure Cloud
WebhooksDeleteResponseProduct
object
2 properties
2 required
RedHatSubscriptionType
string
Type of the subscription
AwsCustomerId
string
AWS Account Reference ID
WebhookTestExecutionResponseRequestOrder
object
10 properties
5 required
AuthPayload
An object describing the type of authentication used by your Webhook URL
HeaderApiKeyAuth
object
3 properties
3 required
Clouds
A string identifying a cloud marketplace
SubscriptionId
string
Subscription Id
PrivateOfferMetadata
object
Contains information for a private offer associated with the subscription
3 properties
PrivateOfferEventsEnabled
boolean
This setting registers webhooks for private offer events. Note: This setting can only be configured on a vendor level webhook but applies to all webhooks, incl…
AwsMarketplaceData
object
Marketplace data specific to AWS
1 property
Entitlement
object
A purchase entitlement for a given cloud marketplace
AuthType
string
The type of authentication used. Supported types are 'basic', 'headerapikey', and 'oauth2'
AzureNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
13 properties
RedHatSubscriptionRenewType
string
Renew Type
ProductId
Cloud Marketplace issued ID for a product
DeleteWebhookResponse
object
1 property
1 required
BasicAuth
object
3 properties
3 required
AwsEntitlement
object
A purchase entitlement from AWS Marketplace
4 properties
4 required
WebhookUrl
string
A valid URL for the endpoint you created to receive Tackle events
Entitlements
array
A list of Entitlement objects
GCPNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
13 properties
WebhookUrlResponse
string
A valid URL for the endpoint you created to receive Tackle events
CreatedAt
string
Creation timestamp, UTC ISO format
PrivateOfferId
string
GetWebhooksResponse
object
2 properties
2 required
EventType
string
Type of event
OtherMarketplaceData
object
GCP, Azure, and Red Hat do not currently have marketplace specific data
AzureCustomerId
string
Azure Subscription ID
AzureProductId
string
Azure Offer ID
WebhooksGetResponse
object
2 properties
2 required
Metadata
object
Metadata for a given request
1 property
1 required
GcpCustomerId
string
GCP External Account ID
AzureEntitlement
object
A purchase entitlement from Azure Marketplace
5 properties
5 required
GcpEntitlement
object
A purchase entitlement from GCP Marketplace
17 properties
5 required
MeteringEventsEnabled
boolean
This setting registers webhooks for metering events. Note: This setting can only be configured on a vendor level webhook but applies to all webhooks, including…
WebhookTestExecutionResponse
object
2 properties
1 required
RedHatEntitlement
object
A purchase entitlement from Red Hat Marketplace
9 properties
9 required
ResponseStatusCode
integer
Client's status code from executing test webhook
SupportedCloudsFilter
object
1 property
1 required
RedHatCloud
string
Red Hat Cloud
AWSNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
14 properties
GetWebhooksResponseList
array
RegistrationDetails
object
Registration details of a purchaser that map to defined registration page fields for a given listing. The following fields are required at a minimum: - Company…
3 properties
3 required
WebhooksDeleteResponseVendor
object
2 properties
2 required
GcpCloud
string
GCP Cloud
GcpProductId
string
GCP Solution ID
AwsPricing
object
Pricing data for AWS
10 properties
RedHatProductId
string
Red Hat Product Id
Oauth2
object
2 properties
1 required
ProductIdFilter
object
1 property
1 required
AzureGcpPricing
object
Pricing data for Azure and GCP
9 properties
GCPPrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
14 properties
OfferId
string
The AWS issued offer ID, Seller created Azure Plan ID, or the GCP issued Quote ID
GroupId
string
AzurePrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
15 properties
AWSPrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
13 properties
RedhatNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
13 properties
WebhooksRequest
object
5 properties
3 required
RedhatPrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
10 properties
IsFreeTrial
boolean
Designation for Free Trial
RedHatTermUnit
string
The unit for the term
WebhooksTestRequest
object
3 properties
2 required
WebhookTestExecutionResponseRequest
CustomerId
Actor
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tackle.io 12
Other APIs Tackle.io publishes across the network.
Tackle.io Authentication API
Tackle.io Contracts API
Tackle.io Currencies API
Tackle.io Customers API
Tackle.io Disbursements API
Tackle.io Entitlements API
Tackle.io Groups API
Tackle.io Invitations API
Tackle.io Invoices API
Tackle.io Marketplace API
Tackle.io Metering API
Tackle.io Notifications API
#Webhooks