Create or Update an Event Webhook Subscription

post

https://api.servicem8.com/webhook_subscriptions/event

Subscribe to business events (e.g., job.created, job.completed). When the specified event occurs, a webhook will be sent to your callback URL with detailed event data.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

event

string

enum

required

Supported events:

company.created: New customer added
company.updated: Customer details updated
form.response_created: Form response submitted
inbox.message_received: New message received in inbox
job.badge_added: Badge added to job
job.badge_removed: Badge removed from job
job.checked_in: Staff member arrived at job site
job.checked_out: Staff member left job site
job.completed: Job marked as completed
job.created: New job created in the system
job.invoice_paid: Full payment received for invoice
job.invoice_sent: Invoice sent to customer
job.note_added: Note added to job
job.photo_added: Photo attached to job
job.queued: Job added to queue
job.quote_accepted: Customer accepted the quote
job.quote_sent: Quote sent to customer
job.review_received: Customer review submitted
job.status_changed: Job status changed
job.updated: Job details modified
job.video_added: Video attached to job
proposal.sent: Proposal sent to customer
proposal.viewed: Proposal viewed by customer
staff.clocked_off: Staff member ended shift
staff.clocked_on: Staff member started shift

callback_url

uri

required

The URL on your server that will receive webhooks when the event occurs.

unique_id

string

length ≤ 100

Optional unique identifier for grouping subscriptions.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json