The current list of events in TidyHQ
These are the event types currently available from the webhooks system. Keep in mind that as new events are added, your wildcards may start to match new events. Some internal events can also trigger an update event, so you may receive updates with only an updated_at
field in changes.
Event Name | Kind | Description | Fields that Trigger Event |
---|---|---|---|
contact.activated | contact | Contact transitions to active (e.g. previously inactive becomes active, active for the first time). | |
contact.deactivated | contact | Contact transitions to inactive (e.g. trashed). | |
contact.merged | contact | Two contacts are merged, also includes extra context. | |
contact.updated | contact | Attributes of contact have changed. | company , contact_id_number , email_address , first_name , gender , kind , last_name , phone_number , profile_image , subscribed |
contact.group.added | contact.group | Contact is added to a group. | |
contact.group.removed | contact.group | Contact is removed from a group. | |
event.created | event | Event is created in draft form. | |
event.activated | event | Event is saved and is available. | |
event.updated | event | Attributes of event have changed. | body , category_id , end_at , image , location , name , public , start_at |
event.deleted | event | Event has been deleted. | |
event.pack.reserved | event.pack | A group of tickets has been reserved for sale. | |
event.pack.activated | event.pack | A group of tickets have been sold. | |
event.pack.expired | event.pack | A group of tickets has exceeded time they can be reserved. | |
event.pack.cancelled | event.pack | A group of tickets have been cancelled. | |
event.ticket.created | event.ticket | Event ticket type has been created. | |
event.ticket.updated | event.ticket | Event ticket type has been updated. | amount , initial_quantity , maximum_purchase , members_only , membership_level , name , pass_code , sales_end |
event.ticket.deleted | event.ticket | Event ticket type has been deleted. | |
finance.order.pending | finance.order | An order is waiting to be processed. | |
finance.order.activated | finance.order | An order has been paid. | |
finance.order.awaiting_payment | finance.order | An order requires manual intervention to have its payment processed. | |
finance.order.rejected | finance.order | An order has failed to process. | |
finance.order.cancelled | finance.order | An order has been cancelled. | |
finance.order.expired | finance.order | An order has exceeded time it can be in a pending state. | |
membership.created | membership | New membership is added. | |
membership.updated | membership | Membership state / dates are updated. | auto_renew , end_date , start_date , state |
membership.deleted | membership | Membership is removed. | |
membership.activated | membership | Membership has been activated. | |
membership.partiated | membership | Membership has been been partially paid for. | |
membership.expired | membership | Membership has expired. | |
membership.cancelled | membership | Membership has been cancelled. | |
subscription.created | subscription | Subscription is created within membership. | |
subscription.updated | subscription | Subscription state / dates are updated. | end_date , start_date , state |
subscription.deleted | subscription | Subscription is deleted. | |
subscription.started | subscription | Subscription transitioned to active state. | |
subscription.expired | subscription | Subscription transitioned to expired date. | |
subscription.continued | subscription | Subscription transitions to active or partial. | |
subscription.cancelled | subscription | Subscription is cancelled. | |
webhook.deleted | webhook | Webhook has been permanently deleted. | |
webhook.activated | webhook | Webhook has been activated. | |
webhook.deactivated | webhook | Webhook has been manually deactivated. | |
webhook.errored | webhook | Webhook has been automatically deactivated after there were too many errors when sending events to the destination URL. |
And the following kinds are are mapped to the API:
Kind | Reference |
---|---|
contact | Contact |
contact.group | To be documented. |
event | To be documented. |
event.pack | To be documented. |
event.ticket | To be documented. |
finance.order | To be documented. |
membership | Membership |
subscription | Subscription |
webhook | Webhook |