Webhooks are HTTP-based callback interfaces. You can use webhooks to provide other applications with real-time information about the transfers for your product.
For example, if you do not have your membership or online course with us, you can have the purchase data transferred to your system and set up or block members if no further payment is received for subscription or installment payments.
Here you can find out how to provide your webhooks URL in the product and which data is transferred.
Creating a template for webhooks URL
- Go to "Templates" and then "Webhooks".
- Create the "template".
- Enter a name for the template.
- Provide your webhooks URL.
- Select all events or individual events.
- Save the template.
Providing a template for the product
- Go to your product and click on "edit".
- Go to the "More".
- Choose whether to enable webhooks.
If you want to enable webhooks, choose whether you want all of them to be enabled or just a specific endpoint.
If only a certain end point is to be activated, select the template that has just been created for it.
Which parameters are transferred?
Only the parameters for which the data is available are transferred. The data therefore depends on the purchase and the buyer data entered.
Buyer:
- id: Id
- email: email address
- first_name: first name
- last_name: last name
- country: country
- city: city
- street: street and house number
- zip: zip code
- company: company
- vat_no: tax number
- phone: phone number
When selling through a publisher:
- id: Id
- email: email address
- first_name: first name
- last_name: last name
- country: country
- city: city
- street: street and house number
- zip: zip code
- company: company
- vat_no: tax number
When selling through a joint venture partner:
- id: Id
- email: email address
- first_name: first name
- last_name: last name
Product data:
- id: product id
- slug: url
- name: product name
- type: product type (digital, e-tickets, voucher, courses, link)
- price: price
When selling as a bundle:
- id: id
- name: name of the bundle
Additional data for tickets:
- count: number of tickets just bought
- codes: ticket code
- reserved_bills_count: Number of reserved tickets
With the voucher:
- voucher_codes: Code for the purchased voucher
For tickets also the event data:
- id: event ID
- name: event name
- price: price
- location_short: Abbreviation place
- location_long: location
- current_code: Ticket code
- code_prefix: Ticket code prefix
- date: date
- date_id: ID of the ticket date
Was the product purchased as a gift:
- id: Id
- email: email address
- first_name: first name
- last_name: last name
- country: country
- city: city
- street: street and house number
- zip: zip code
- company: company
- vat_no: tax number
- phone: phone number
Additional information:
- add_id_1: incoming url parameter “add_id_1”
- add_id_2: incoming url parameter “add_id_2”
- bill_number: bill number
- revenue: total revenue
- amount: earnings
- fee: transaction-related fees
- vat_rate: VAT in %
- vat_amount: VAT amount
- campaign_id: incoming URL parameter "campaign ID"
- coupon_code: Coupon code
- recurring: subscription / Installment payments =yes/no
- recurring_form: Type of payment one-time payment, subscription, limited subscription, installment payment
- payment_method: Payment method
- Payment status
- created_date: Purchase date
- success_date: Date of payment / delivery
- success_date_short: date of payment / delivery (short)
- invoice_link: Link to customer invoice
- success_link: Link to the thank you page