Skip to main content

Webhooks

Hannah avatar
Written by Hannah
Updated yesterday

A webhook is an HTTP callback. It is an efficient way to have data sent to a user based on specific events within a Webconnex product. If you are familiar with webhooks, you can view full documentation here.

Warning: In order to utilize our Webhooks feature, you must have a working knowledge of Webhooks and the tools to use them. If you need guidance on finding something in the documentation or think something is not functioning as intended, our support team is happy to help field your questions. But our team does not provide support for developing or maintaining Webhooks.

Jump To...

Add a Webhook

  • From the Pages screen, hover over the Extras tab in the top menu bar

  • Select Integrations

  • Click Add Integration

  • Select the Webhooks option

  • Enter the Webhook Name

  • Enter the Webhook Endpoint URL

  • Click Save and Continue


Customize a Webhook

  • Name

  • App Key (this field is optional)

  • App/API Token (this field is optional)

  • URL

  • Status Toggle: This toggle turns the webhook on or off. If this is turned off, no data will be sent out

  • Events: Under this field, you can toggle specific ‘events’ on that will happen within the Webconnex platform

    • New Registration: When a registrant submits a new registration

    • Subscription/Deposit Processed: When a subscription or final deposit is paid

    • Form publish: When a form (that is selected from the form list) is published, whether new or updated

    • Inventory supply: When inventory is used on forms, it will update you at a few intervals so inventory is tracked

    • Coupon creation/edit: Whenever a new coupon is made by a user or a coupon is edited

  • Send Data from Every Page: This toggle will indicate whether to include all created, and newly made, forms on the list to actively send out the webhooks. If this option is toggled off, you will be given a list where you can select or deselect the forms you want to include in this webhook

  • Send a Test: You can use this field to submit test registrations to see how the data will look on your side. You can expand to see Send a Registration, Send a Subscription, Send a Form Publish, and Send a Coupon

  • To view the status of a specific webhook, you can scroll to the bottom of the page, and see all individual webhooks there. You can expand to see the Payload, Request, Response, and more.

Note: Webhooks are not supported for pre-registration or waitlist registrations right now.

Pro Tip: Webhooks are not delivered in real-time and should not be relied on for real-time or synchronous workflows.


View Recent Deliveries

  • From the Pages screen, hover over the Extras tab in the top menu bar

  • Select Integrations

  • Select the pencil under the Webhook you want to view

  • Scroll to the bottom of the page. Use the Recent Deliveries section to view a log of all the requests made for a given Webhook

Note: The Recent Deliveries section can be used to view your server's response to the sent webhook to help troubleshoot any potential problems. You can click on the details of a request to reveal more information that might be useful in troubleshooting problems. You can also resend your webhook from this panel.


Nerdy Information

If you are a developer looking to set up a webhook, here is some helpful information about webhooks. Note: for full webhook documentation, click here.

Headers

Parameter

Description

Content-Type

application/json

User-Agent

Webconnex-Divvy

X-Webconnex-Delivery

Hash for the delivery

X-Webconnex-Event

Event types being sent ie.. registration, edit_registrant, cancel_order, etc...

X-Webconnex-Signature

HMAC for the webhook. Note: Remains unchanged on resend events

Webhook Events

Registration Notification

The registration event is fired whenever a successful registration has occurred on a form that you have set up a webhook for. The payload will resemble the fields in the form tied to the webhook event.


Payload

Parameter

Default

Description

eventType

string

registration

accountId

integer

Id of the account

formId

integer

Id of the form

customerId

integer

Id of the customer

eventId

integer

Id of the registration webhook event

data

object

Object contains the complete payload for the registration

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

billing

object

Object contains the billing information

id

string

Unique hash for the registration

lookupId

integer

Internal id of the registration

customerId

integer

Id of the purchasing customer

currency

string

The string representation of the order's currency

deductibleTotal

float

The total deductible amount of the order

orderNumber

string

Unique order number built from accounting reference in the form

orderStatus

string

Status of the order

registrants

object

Object contains all the fields for the registrant(s)

tickets

object

Object contains all the fields for the ticket(s)

total

float

The total value of the registration

transactionReference

string

Transaction reference of the registration

transactionId

integer

Transaction Id of the registration

registrationTimestamp

timestamp

UTC date and time

Meta Object

Parameter

Default

Description

name

string

The name of the webhook

appKey

string

Self assigned application key (optional)

Form Publish Notification

The publish event is fired whenever a successful form has been published on a form that you have set up a webhook for.


Payload

Parameter

Default

Description

eventType

string

The event type - "publish"

accountId

integer

Id of the account

formId

integer

Id of the form

eventId

integer

Id of the publish webhook event

data

object

Object contains the complete payload for the publish event

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

accRef

string

Form accounting reference

currency

string

Currency of the campaign

datePublished

timestamp

Date form was last published

eventEnd

timestamp

Event end date (optional)

eventStart

timestamp

Event start date (optional)

id

integer

Id of the form

name

string

Name of the form

product

string

Product of the form

publishedPath

string

Name of the form

registrationEnd

timestamp

Ending date for registration (optional)

registrationStart

timestamp

Opening date for registration (optional)

status

string

Status of the form

timeZone

string

Timezone of the form

Meta Object

Parameter

Default

Description

name

string

The name of the webhook

appKey

string

Self assigned application key (optional)

Subscription / Reoccurring Notification

The subscription / reoccurring event is fired whenever a successful subscription or deposit has been completed on a form that you have set up a webhook for.

Payload

Parameter

Default

Description

eventType

string

The event type - "subscription"

accountId

integer

Id of the account

formId

integer

Id of the form

customerId

integer

Id of the purchasing customer

eventId

integer

Id of the subscription webhook event

data

object

Object contains the complete payload for the subscription event

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

id

string

Internal Id of the subscription

lookupId

string

Id of the subscription

customerId

integer

Id of the customer

billing

object

Object contains the billing information

orderNumber

string

Unique order number built from the form accounting reference

orderStatus

string

Status of the order

currency

string

The currency of campaign

deductibleTotal

float

The total deductible amount of the order

subscription

object

Object contains the subscription/reoccurring information

transactionReference

string

The transaction reference of processed transaction

transactionId

integer

Transaction Id of the subscription

total

float

The total value processed

Subscription Object

Parameter

Default

Description

amount

float

The amount value of the subscription/reoccurring payment

category

string

Designated fund

dateCreated

timestamp

Date of creation

dateUpdated

timestamp

Date last updated (optional)

dateLast

timestamp

Date of last processed

dateNext

timestamp

Date of next process attempt

email

string

Email address of the subscription/reoccurring payment

id

integer

Internal id of the subscription/reoccurring payment

schedule

string

Cron formatted string detailing the schedule

scheduleString

string

Human readable schedule

status

string

The current status of the subscription/reoccurring payment

Meta Object

Parameter

Default

Description

name

string

The name of the webhook

appKey

string

Self assigned application key (optional)

Reoccurring SMS Donation Notification (Beta)

The sms event is fired whenever followup sms donation is created. Please contact support if you are interested in joining the "Reoccurring SMS Donation Notification" Beta test program.

Note: This notification only includes followup donations. The initial text 2 give donation is sent though the New Registrations/Orders webhook.

Payload

Parameter

Default

Description

eventType

string

The event type - "sms"

accountId

integer

Id of the account

formId

integer

Id of the form

customerId

integer

Id of the purchasing customer

eventId

integer

Id of the subscription webhook event

data

object

Object contains the complete payload for the subscription event

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

id

string

Id of the Order

lookupId

string

Internal Id of the Order

customerId

integer

Id of the customer

transactionId

integer

Id of the transaction

transactionReference

string

The transaction reference of processed transaction

transactionStatus

string

The result of the transaction (See appendix for details)

orderStatus

string

Status of the order (See appendix for details)

orderNumber

string

Unique order number built from the form accounting reference

total

float

The total value processed

currency

string

The currency of campaign

deductibleTotal

float

The total deductible amount of the order

email

string

Email address of tied to the Order

category

string

Designated fund

donorNumber

string

The personal number of the donor used to text in

text2GiveNumber

string

The donation level tied to the campaign

billing

object

Object contains the billing information

Inventory Notification

The inventory event is fired whenever an inventory item reaches 80%, 90% and 100% sold capacity on a form that you have set up a webhook for.

Payload

Parameter

Default

Default

eventType

string

The event type - "inventory_80", "inventory_90", "inventory_100"

formId

integer

Id of the form

accountId

integer

Id of the account

eventId

integer

Id of the inventory webhook event

data

object

The object contains the complete payload for the inventory event

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

dateCreated

timestamp

Date the inventory item was created

dateUpdated

timestamp

Date the inventory item was updated (optional)

formLookupId

int

Id of the form used for requesting when calling from the public api

formName

string

The name of the form campaign

id

string

Id of the inventory item

inventory

object

An object containing the inventory supply data

itemName

string

The name of the inventory item

itemPath

string

The path of the inventory item

lookupId

int

Id of the inventory item used for requesting when calling from the public api

Inventory Object

Parameter

Default

Description

quantity

int

The inventory limit

sold

int

The amount inventory sold

Meta Object

Parameter

Default

Description

name

string

The name of the webhook

appKey

string

Self assigned application key (optional)

Coupons Notification

The coupon event is fired whenever coupon is created, updated or redeemed. Only global and forms that you have enabled will be delivered by the webhook.

Payload

Parameter

Default

Description

eventType

string

The event type - "coupon"

accountId

integer

Id of the account

formId

integer

Id of the form

eventId

integer

Id of the coupon webhook event

data

object

The object contains the complete payload for the coupon event

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

couponId

int

Id of the coupon

available

int

Number of available redemptions ([-1] means unlimited)

redeemed

int

Number of redemptions

codes

object

The object container of all the coupon code objects

currency

string

The currency of coupon

codes

object

The object container of all the coupon code objects

name

string

The name of the coupon

formId

string

Id of the associated form (optional) [null] if coupon is global)

voucher

bool

Specifies if coupon is a voucher or not

dateCreated

timestamp

Date the inventory item was created

dateUpdated

timestamp

Date the inventory item was updated (optional)

Codes Object

Parameter

Default

Description

id

int

Id of the code

couponId

int

Id of the parent coupon

code

string

Code used for coupon redemption

redeemed

int

Number of redemptions

Discounts Object

Parameter

Default

Description

paths

[] string

An array of paths the coupon can be applied to

perTicket

bool

Specifies weather discount should apply to each ticket (ticketspice.com only)

valueType

string

Specifies the discount type - Percent or Fixed

value

string

Value amount to apply

Edit/Cancel Registrant Notification

The edit/cancel registrant event is fired whenever a successful edit or cancellation has occurred on a form that you have set up a webhook for. The payload will resemble the fields in the form tied to the webhook event.

Payload

Parameter

Default

Description

eventType

string

edit_registrant/cancel_registrant

accountId

integer

Id of the account

formId

integer

Id of the form

customerId

integer

Id of the customer

eventId

integer

Id of the registrant webhook event

data

object

Object contains the complete payload for the registrant

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

id

string

Unique hash for the registrant

lookupId

integer

Internal id of the registrant

amount

float

The total value of the registrant

customerId

integer

Id of the purchasing customer (Optional)

currency

string

The string representation of the order's currency

orderNumber

string

Unique order number built from accounting reference in the form

data

object

Object containing collected data fields on ticket

orderId

string

Unique order id

status

string

Status of the order

source

string

Source of the edit

registrantTimestamp

timestamp

UTC date and time

Meta Object

Parameter

Default

Description

name

string

The name of the webhook

appKey

string

Self assigned application key (optional)

Edit/Cancel Ticket Notification

The edit/cancel ticket event is fired whenever a successful edit or cancellation has occurred on a form that you have set up a webhook for. The payload will resemble the fields in the form tied to the webhook event.

Payload

Parameter

Default

Description

eventType

string

edit_ticket/cancel_ticket

accountId

integer

Id of the account

formId

integer

Id of the form

customerId

integer

Id of the customer

eventId

integer

Id of the ticket webhook event

data

object

Object contains the complete payload for the ticket

meta

object

Object contains information about the webhook

Data Object

Parameter

Default

Description

id

string

Unique hash for the ticket

lookupId

integer

Internal id of the ticket

amount

float

The amount value of the ticket

fee

float

The fee value of the ticket

total

float

The total value of the ticket

customerId

integer

Id of the purchasing customer (Optional)

currency

string

The string representation of the order's currency

orderNumber

string

Unique order number built from accounting reference in the form

orderId

string

Unique order id

status

string

Status of the order

source

string

Source of the edit

data

object

Object containing collected data fields on ticket

selectedDate

timestamp

UTC date and time of selected day (optional)

label

string

Label of selected ticket level

eventKey

string

Event key of selected event (optional)

eventLabel

string

Event label of selected event (optional)

timeslot

string

Timeslot for selected ticket (optional)

ticketTimestamp

timestamp

UTC date and time

Meta Object

Parameter

Default

Description

name

string

The name of the webhook

appKey

string

Self assigned application key (optional)

Did this answer your question?