Event Types

Subscribe to specific event types to control which webhook deliveries your endpoint receives. Events are grouped by entity type.

Subscribing to Events

When configuring your webhook, specify the event types you want in the subscribedEventTypes array:

{
    "subscribedEventTypes": [
        "job_created",
        "job_completed",
        "quote_approved",
        "property_created"
    ]
}

You can subscribe to any combination of events. Only events matching your subscriptions will be delivered.

Job Events

Events related to job lifecycle and management.

Event Type	Description
`job_created`	A new job was created
`job_assigned_to_service_providers`	Job was assigned to one or more service providers
`job_fulfilment_accepted`	A service provider accepted the job
`job_fulfilment_rejected`	A service provider rejected the job
`job_cancelled`	Job was cancelled
`job_fulfilment_cancelled`	A service provider's fulfilment was cancelled
`job_completed`	Job was marked as complete
`job_quote_number_updated`	Quote number was updated on the job
`job_fulfilment_completed`	A service provider completed their fulfilment
`job_fulfilment_quote_uploaded`	Service provider uploaded a quote
`job_fulfilment_site_visit_scheduled`	Site visit was scheduled
`job_fulfilment_job_visit_scheduled`	Job visit was scheduled
`job_fulfilment_media_uploaded`	Supporting media was uploaded
`job_fulfilment_invoice_uploaded`	Invoice was uploaded by service provider
`job_fulfilment_substatus_updated`	Fulfilment sub-status changed
`job_fulfilment_rating_submitted`	Service provider was rated
`job_reminder_sent`	A reminder was sent for the job
`job_fulfilment_reminder_sent`	A reminder was sent for a fulfilment
`job_name_updated`	Job name was changed
`job_substatus_updated`	Job sub-status changed
`job_payment_responsibility_updated`	Payment responsibility assignment changed
`job_active_service_provider_removed`	An active service provider was removed from the job

Quote Events

Events related to quote management.

Event Type	Description
`quote_approved`	A quote was approved
`quote_rejected`	A quote was rejected
`quote_requote_requested`	A re-quote was requested
`quote_outdated`	A quote was marked as outdated

Invoice Events

Events related to invoice management.

Event Type	Description
`invoice_approved`	An invoice was approved
`invoice_disputed`	An invoice was disputed
`invoice_cancelled`	An invoice was cancelled

Approval Events

Events related to the approval workflow.

Event Type	Description
`approval_created`	A new approval was created
`approval_approved`	An approval was approved
`approval_rejected`	An approval was rejected
`approval_pending`	An approval is pending
`approval_requote`	An approval triggered a re-quote

Property Events

Events related to property management.

Event Type	Description
`property_created`	A new property was created
`occupant_added`	An occupant was added to a property
`occupant_removed`	An occupant was removed from a property
`landlord_added`	A landlord was added to a property
`landlord_removed`	A landlord was removed from a property
`trustee_added`	A trustee was added to a property
`trustee_removed`	A trustee was removed from a property
`property_address_updated`	Property address was updated
`property_assigned_to_agent`	Property was assigned to an agent

Estate Events

Events related to complex/estate management.

Event Type	Description
`estate_created`	A new estate was created
`estate_updated`	Estate details were updated
`estate_manager_added`	A manager was added to the estate
`estate_manager_removed`	A manager was removed from the estate
`property_linked`	A property was linked to the estate
`property_unlinked`	A property was unlinked from the estate
`estate_assigned_to_agent`	Estate was assigned to an agent

Agent Events

Events related to agent account management.

Event Type	Description
`agent_created`	A new agent was created
`agent_deactivated`	An agent was deactivated
`agent_role_updated`	Agent role was changed
`agent_accepted_terms`	Agent accepted terms of service
`agent_email_updated`	Agent email was changed
`agent_mobile_number_updated`	Agent mobile number was changed
`agent_signed_in_via_email_link`	Agent signed in via email link
`agent_deleted`	Agent was deleted
`agent_invited`	Agent was invited to the agency
`agent_agency_changed`	Agent changed agency

Agency Events

Events related to agency management.

Event Type	Description
`agency_created`	A new agency was created
`agency_updated`	Agency details were updated
`agency_deactivated`	Agency was deactivated

Service Provider Events

Events related to service provider accounts and operations.

Event Type	Description
`service_provider_created`	A new service provider was created
`service_provider_signin_via_email_link`	SP signed in via email link
`service_provider_accepted_terms`	SP accepted terms of service
`service_provider_category_added`	SP added a service category
`service_provider_category_removed`	SP removed a service category
`service_provider_personal_info_updated`	SP personal info was updated
`service_provider_company_info_updated`	SP company info was updated
`service_provider_location_added`	SP added a service location
`service_provider_location_removed`	SP removed a service location
`service_provider_verified`	SP was verified
`service_provider_unverified`	SP verification was revoked
`service_provider_category_activated`	SP category was activated
`service_provider_category_deactivated`	SP category was deactivated
`service_provider_contact_viewed`	SP contact details were viewed
`service_provider_blocked`	SP was blocked
`service_provider_unblocked`	SP was unblocked
`service_provider_disabled`	SP was disabled
`service_provider_enabled`	SP was enabled
`service_provider_documents_requested`	Documents were requested from SP
`service_provider_deactivation_requested`	Deactivation was requested
`service_provider_deactivation_request_dismissed`	Deactivation request was dismissed
`service_provider_deactivated`	SP was deactivated
`ops_service_provider_location_added`	Ops added a SP location
`ops_service_provider_location_updated`	Ops updated a SP location
`ops_service_provider_location_removed`	Ops removed a SP location
`ops_service_provider_locations_requested`	Ops requested SP locations

Thread & Message Events

Events related to messaging and threads.

Event Type	Description
`thread_created`	A new thread was created
`thread_updated`	Thread was updated
`messages_read`	Messages were marked as read
`user_added`	A user was added to a thread
`user_removed`	A user was removed from a thread
`message_sent`	A message was sent
`message_deleted`	A message was deleted

User Events

Event Type	Description
`password_reset_requested`	A password reset was requested

Communications Events

Events related to outbound communications.

Event Type	Description
`email_sent`	An email was sent
`email_failed`	An email failed to send
`whatsapp_sent`	A WhatsApp message was sent
`whatsapp_failed`	A WhatsApp message failed to send
`push_notification_sent`	A push notification was sent

Tips

Start narrow

Subscribe only to the events you need. You can always add more later by updating your configuration.

Use entity type prefixes

Event types follow the pattern {entity}_{action} or {entity}_{sub-entity}_{action}, making them easy to filter programmatically.