| Name | Type | Description | Example Values |
|---|
| actor | object | Acting user details in JSON key value pairs | {"email": "[email protected]", "name": "John Smith", "picture": "https://www.example.com/jpeg", "user_id": "abc123"} |
| marketplace | string | Name of cloud provider | aws |
| created_at | string | UTC timestamp | "2021-02-16T14:48:06.460998+00:00" |
| customerid | string | Cloud Marketplace issued Buyer Account ID | AWS Account Reference ID: abc123def45 |
| destination | string (constant) | Internal Tackle event type. | callback |
| event_type | string | Type of event | private_offer_created private_offer_created_in_marketplace private_offer_failed_to_create_in_marketplace private_offer_purchase_instructions_sent private_offer_invitation_opened private_offer_viewed private_offer_accepted private_offer_cancelled_in_marketplace private_offer_failed_to_cancel_in_marketplace |
| extra_data | object | Optional additional event data | |
| group_id | string | Internal Tackle event ID | 5e7b1ec8-2595-40c7-b6f1-3b0d1fd1ed9e |
| offerid | string | AWS issued Offer ID. null until private_offer_created_in_marketplace fires. | offer-abcdefghijkl1 |
| po_id | string | Tackle issued Private Offer ID | 7ec896c2-6cff-4a46-b55a-039db504422d |
| productid | string | Cloud Marketplace issued Product ID | AWS Product Code: 1test1a2b3c4d5e6f7g8h9ijk |
| source | string | Internal Tackle event source data | |
| private_offer_metadata | object | See table below | |
| vendorid | string | Tackle issued identifier for the vendor | T35T01 |
| is_free_trial | boolean | A true/false boolean value representing if the order is a free trial | true or false |
| tackle_subscription_id | string | Tackle generated identifier unique for each Subscription. | 52fZSV7JbMI |
| test | boolean | Boolean value representing if payload has been generated by webhooks test endpoint | true or false |
| offer_type | string | The type of the offer. Present on marketplace sync events (private_offer_created_in_marketplace, private_offer_failed_to_create_in_marketplace, private_offer_cancelled_in_marketplace, private_offer_failed_to_cancel_in_marketplace). | direct or partner_resale |
| buyer_company_name | string | The company name of the buyer. Present on marketplace sync events. | Aperture Science, Inc. |
| buyer_billing_account_ref | string | The marketplace ID of the buyer's billing account. For AWS, this is the buyer's AWS Account Number. Present on marketplace sync events. | 533037066561 |
| salesforce_id | string | The ID of the Opportunity or other corresponding Salesforce object. Present on marketplace sync events. | SF_OPPORTUNITY_ID |
| created_in_marketplace_at | string | RFC3339 timestamp representing when the offer was successfully created in the marketplace. Present on private_offer_created_in_marketplace; null on failure events. | 2024-03-20T15:04:19.131516+00:00 |
| errors | object[] | Array of error objects. Present on failure events (private_offer_failed_to_create_in_marketplace, private_offer_failed_to_cancel_in_marketplace). Each object contains code (durable machine-readable identifier) and message (human-readable explanation). | [{"code": "invalid-dimension-api-name", "message": "A valid dimension api name is required to be created in the marketplace."}] |
The private offer metadata object contains more details on a Private Offer.
| Name | Type | Description | Example Value |
|---|
| buyers | object[] | Buyers are a list of contacts that receive your offer invitation email | "buyers": [{"title": "Buyer", "email_address": "[email protected]", "full_name": "Bertram Gilfoyle"}] |
| renewal | boolean | This identifies if the offer is a renewal or not | true or false |
| eula | object | This contains the End User Licensing Agreement for this offer and any documents that are a part of the customer's contract | "eula": {"type": "public", "files": []} |
| offer_metadata | object | This is the Contract Metadata you may have filled up in Tackle Offers | "offer_metadata": {"AWS Account Number": "533037066561"} |
| pre_registration_details | object | These are the Registration Details you may have filled up in Tackle Offers | "pre_registration_details": {"billing_street": "1 Pied Way", "billing_country": "United States", "billing_city": "Redwood City", "Company": "Pied Piper", "billing_state": "CA"} |
| pricing | object | This is the pricing information you might have filled up in Tackle Offers | "pricing": {"net_contract_value": "40000.00", "duration": "1 Months", "schedule": [{"invoice_amount": "1000.00", "invoice_date": "2021-10-22T00:00:00.000-06:00"}], "show_on_email": false, "marketplace_fee": "0.00", "monthly_contract_value": "20000.00", "version": "simple-pricing-v1-aws", "dimensions": [{"name": "Enterprise", "dimension_value": "40000", "quantity": "2", "price": "20000"}], "total_contract_value": "40000.00"} |
| offer_expiration_at | string | UTC timestamp | "offer_expiration_at": "2021-02-09T12:38:04.00.000Z" |
| accepted_at | string | UTC timestamp | "accepted_at": "2021-02-04T10:23:06.00.000Z" |
| cancelled_at | string | UTC timestamp | "cancelled_at": "" |
| archived_at | string | UTC timestamp | "archived_at": "" |
| opened_instructions_at | string | UTC timestamp | "opened_instructions_at": "2021-02-02T16:53:23.00.000Z" |
| viewed_offer_at | string | UTC timestamp | "viewed_offer_at": "2021-02-01T13:04:23.00.000Z" |
| source_offer_id | string | The last accepted offer ID for an agreement in AWS. This is used to track and identify agreement-based offers (ABOs) in Tackle. | "source_offer_id": "offer-1a2abcdefghijk" |
| last_modified_at | string | UTC timestamp | "last_modified_at": "2021-02-01T09:29:00.00.000Z" |
