Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tackle Webhooks API

Operations for Webhooks

Tackle Webhooks API is one of 25 APIs that Tackle 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://api.tackle.io.

7 operations 4 paths 76 schemas 2 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.tackle.io
Authentication
HTTP Bearer, HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Tackle Webhooks API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuthCallback). An API key is passed in the header as subscription-key (HeaderApiKeyAuthCallback). It supports OAuth 2.0 (Oauth2AuthCallback) using the clientCredentials flow.

  • BearerAuth — The Tackle API requires a JWT for authentication. You can get this by [getting your API credentials](https://developers.tackle.io/docs/how-to-get-an-m2m-client…
  • BasicAuthCallback — Use basic for [basic HTTP authentication](https://en.wikipedia.org/wiki/Basicaccessauthentication); this is only used for callbacks
  • HeaderApiKeyAuthCallback — Use headerapikey to specify a custom HTTP request header for authentication. Requests from Tackle will use the specified HTTP header for outbound requests to y…
  • Oauth2AuthCallback — This auth-type is for oauth2 client credentials flow. We will use the clientid and clientsecret to call the tokenurl to get an access token; this is only used…

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
v1-create-or-update-webhook body → 200400401403
GET
/v1/webhooks
Get All Webhooks for Vendor
v1-get-all-webhooks → 200400401403
POST
/v1/webhooks/test
Test a Webhook
v1-test-webhook body → 200400401403
DELETE
/v1/webhooks/vendor
Delete a Vendor-Level Webhook
v1-delete-webhook → 200400401403404
GET
/v1/webhooks/vendor
Get a Vendor-Level Webhook
v1-get-vendor-webhook → 200400401403404
DELETE
/v1/webhooks/product/{productid}
Delete a Product-Level Webhook
v1-delete-product-webhook 1 param → 200400401403404
GET
/v1/webhooks/product/{productid}
Get a Product-Level Webhook
v1-get-product-webhook 1 param → 200400401403404

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are GcpEntitlement (17 properties), WebhookTestExecutionResponseRequestPO (17 properties), AzurePrivateOfferCallback (15 properties), GCPPrivateOfferCallback (14 properties). Each schema is shown below with its type and property counts.

WebhookUrlResponse
string
A valid URL for the endpoint you created to receive Tackle events
RedhatPrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
10 properties
AwsMarketplaceData
object
Marketplace data specific to AWS
1 property
GcpEntitlement
object
A purchase entitlement from GCP Marketplace
17 properties 5 required
IsFreeTrial
boolean
Designation for Free Trial
GCPNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
13 properties
GCPPrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
14 properties
OtherMarketplaceData
object
GCP, Azure, and Red Hat do not currently have marketplace specific data
AzureCustomerId
string
Azure Subscription ID
AwsPricing
object
Pricing data for AWS
10 properties
Metadata
object
Metadata for a given request
1 property 1 required
WebhookTestExecutionResponse
object
2 properties 1 required
ProductId
Cloud Marketplace issued ID for a product
GcpProductId
string
GCP Solution ID
WebhooksGetAllResponseObject
object
4 properties
CreatedAt
string
Creation timestamp, UTC ISO format
GcpCloud
string
GCP Cloud
WebhookTestExecutionResponseRequest
WebhooksGetResponse
object
2 properties 2 required
AwsCustomerId
string
AWS Account Reference ID
AuthPayload
An object describing the type of authentication used by your Webhook URL
CustomerId
AzureGcpPricing
object
Pricing data for Azure and GCP
9 properties
AwsCloud
string
AWS Cloud
DeleteWebhookResponse
object
1 property 1 required
AzureEntitlement
object
A purchase entitlement from Azure Marketplace
5 properties 5 required
ResponseStatusCode
integer
Client's status code from executing test webhook
Error
object
4 properties 3 required
Entitlement
object
A purchase entitlement for a given cloud marketplace
OfferId
string
The AWS issued offer ID, Seller created Azure Plan ID, or the GCP issued Quote ID
Entitlements
array
A list of Entitlement objects
AzureNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
13 properties
RedHatEntitlement
object
A purchase entitlement from Red Hat Marketplace
9 properties 9 required
AWSNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
14 properties
WebhookTestExecutionResponseRequestPO
object
17 properties
WebhooksDeleteResponseProduct
object
2 properties 2 required
SupportedCloudsFilter
object
1 property 1 required
EventType
string
Type of event
WebhooksRequest
object
5 properties 3 required
SubscriptionId
string
Subscription Id
WebhooksTestRequest
object
3 properties 2 required
ProductIdFilter
object
1 property 1 required
BasicAuth
object
3 properties 3 required
PrivateOfferMetadata
object
Contains information for a private offer associated with the subscription
3 properties
AWSPrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
13 properties
WebhooksRequestFilters
An object with either a valid productid or supportedclouds
WebhooksDeleteResponseVendor
object
2 properties 2 required
HeaderApiKeyAuth
object
3 properties 3 required
AzureCloud
string
Azure Cloud
GetWebhooksResponseList
array
AuthType
string
The type of authentication used. Supported types are 'basic', 'headerapikey', and 'oauth2'
RedHatSubscriptionType
string
Type of the subscription
AzurePrivateOfferCallback
object
Link to information on Private Offer payload variables https://developers.tackle.io/reference/private-offer-payloads
15 properties
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
WebhooksUpsertResponse
object
2 properties 1 required
RedhatNewOrderCallback
object
Link to New Offer payload variables https://developers.tackle.io/reference/payload-variables
13 properties
Clouds
A string identifying a cloud marketplace
RedHatProductId
string
Red Hat Product Id
VendorId
string
Tackle issued identifier for the Vendor
GroupId
string
Actor
object
4 properties
RedHatCustomerId
string
Red Hat Customer Id
GetWebhooksResponse
object
2 properties 2 required
RedHatCloud
string
Red Hat Cloud
WebhookTestExecutionResponseRequestOrder
object
10 properties 5 required
RedHatSubscriptionRenewType
string
Renew Type
RedHatTermUnit
string
The unit for the term
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…
AwsProductId
string
AWS Product Code
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…
AzureProductId
string
Azure Offer ID
PrivateOfferId
string
WebhookUrl
string
A valid URL for the endpoint you created to receive Tackle events
Oauth2
object
2 properties 1 required
GcpCustomerId
string
GCP External Account ID
AwsEntitlement
object
A purchase entitlement from AWS Marketplace
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackle-webhooks-api-openapi.yml Raw ↑

Other APIs Tackle publishes across the network.

Tackle Authentication API
Tackle Contracts API
Tackle Currencies API
Tackle Disbursements API
Tackle Entitlements API
Tackle Groups API
Tackle Invitations API
Tackle Invoices API
Tackle Marketplace API
Tackle Metering API
Tackle Notifications API
Tackle Opportunities API