In this article, you will learn how to create, manage, and monitor webhooks from the Developer settings page.
Webhooks let you automatically send real-time data from Workiz to other apps or platforms whenever specific events occur — like when a new job is created or a lead changes status. With just a few clicks, you can build powerful integrations without writing a single line of code.
Creating webhooks
- Each webhook is an automation rule made of a trigger, optional conditions, and a post webhook action. When you create a webhook from the Developer page, the post webhook action is already added for you.
- From the navigation bar, select the profile icon > Settings
- Under Integrations, select Developer
- On the v2 tab, select Create new > Webhook
- Enter a Rule title so you can find this webhook later
-
Set the trigger by selecting the record and the event (for example, When a job is created
Webhooks only work with triggers for jobs, leads, invoices, and estimates.
- Select add url and enter:
- URL: the endpoint the webhook data will be posted to
- (Optional) Auth key: sent as a Bearer token in the authorization header
-
Then, select Save
- (Optional) Select Add condition to limit when the webhook is sent, like only for a specific job type or ad source
- Select Add automation
- Your new webhook appears in the Webhooks tab.
You can still create webhooks from the Automation Center by choosing the post webhook action. Webhooks created there also appear in the Webhooks tab.
Managing your webhooks
To see all of your webhooks, go to the Developer settings page and select the Webhooks tab. This includes webhooks created from the Developer page and from the Automation Center.
| Column | What it shows |
|---|---|
| On/Off | Whether the webhook is currently active |
| Title | The rule title you gave the webhook |
| Trigger event | The event that sends the webhook (for example, Job status → Done) |
| URL | The endpoint the data is posted to |
| Auth key | The auth key, hidden by default. You can copy it. |
| Actions | More options for the webhook |
Turning a webhook on or off
Use the On/Off toggle next to a webhook to turn it on or off. A webhook that is turned off won't send any data until you turn it back on.
Editing a webhook
- In the Webhooks tab, find the webhook and select Actions (⋮) > Edit
- Update the trigger, URL, auth key, or conditions
- Save your changes
From the Actions (⋮) menu, you can also Preview, Duplicate, Rename, or Delete a webhook.
To pause a webhook for a while, turn it off instead of deleting it. That way, you won't need to set it up again.
Viewing webhook activity
Use the logs on the Developer settings page to see when webhooks were sent and whether they went through.
- On the Developer page, select View Logs
- Select + Add Filter > Type > Webhook, then select Apply
Each log entry shows the Status, Method, Type, URL, and Time of the request. Logs show the last 14 days by default. To narrow them down further, you can search or add more filters:
- Date: change the time range
- Method: filter by request method
- Status code: filter by response code
- Errors only: show only requests that failed
If a connected app isn't receiving data, filter by Webhook and Errors only to quickly find failed requests.
To return to the main Developer page, select Back to API Keys.
Payload examples
Workiz currently offers webhooks job, lead, estimate, and invoice events.
For a better understanding of the payload format, please see the sections below:
{ "trigger": { "type": "job_created", "timestamp": "2024-03-15T10:30:00Z" }, "data": { "id": "JOB-BA5r7o4bqzR9MONa", "uuid": "3YBIBO", "serialId": 12345, "status": "Submitted", "subStatus": "Submitted", "date": "2022-01-01 10:00:00", "endDate": "2022-01-01 10:00:00", "isAllDay": false, "jobType": { "id": "JT-8718036049ec4c4d", "name": "Repair" }, "adGroup": { "id": "AG-71b8d7310acbf8cc", "name": "Ad Group 1" }, "description": "This is a description of the job", "subTotal": 946, "taxableAmount": 946, "taxPercent": 10.111, "taxAmount": 10.51, "costing": 10.51, "techExpenses": 12.51, "tipAmount": 43.51, "totalPrice": 956.51, "amountDue": 956.51, "amountDueDate": "2022-01-01 10:00:00", "converted": true, "clientInfo": { "clientId": "CL-OvmDp2yvv1yqMwRl", "serialId": 1023, "firstName": "John Doe", "lastName": "Doe", "companyName": "Sample Company name", "email": "client@workiz.com", "primaryExt": "619", "primaryPhone": "6195555555", "secondaryExt": "613", "secondaryPhone": "6195555555", "addressDetails": { "country": "US", "state": "US", "city": "San Francisco", "zipcode": "94102", "address": "462 Powell St", "unit": "3422", "latitude": "San Francisco", "longitude": "San Francisco", "locationKey": "San Francisco" }, "serviceArea": { "id": "SA-71b8d7310acbf8cc", "name": "San Francisco" } }, "team": [ { "id": "USR-38c1ee5c4efa38a4", "name": "John Doe" } ], "lineItems": [ { "id": "JLI-BA5r7o4bqzR9MONa", "productId": 1000, "name": "Deadbolt", "description": "Deadbolt replacement, any color and size", "price": 100, "quantity": 1, "total": 100, "cost": 100, "taxable": true, "discountable": true, "inventoryManaged": true, "inventorySync": true, "optionalConverted": true } ], "tags": [ { "id": "TAG-8cddc18e7b0458fa", "name": "Estimate" } ], "customFields": [ { "id": "CF-eYLPK7198xVp6Z8q", "fieldName": "Custom Field 1", "value": "John Doe" } ], "notes": [ { "id": "JNT-8cddc18e7b0458fa", "techName": "John Doe", "note": "This is a note", "timestamp": "2022-01-01 10:00:00" } ], "statusUpdated": "2022-01-01 12:00:00", "updatedAt": "2022-01-01 12:00:00", "createdAt": "2022-01-01 10:00:00" }, "metadata": { "automationId": "auto_789", "ruleName": "New Job Notification" } }{ "trigger": { "type": "lead_created", "timestamp": "2024-03-15T10:30:00Z" }, "data": { "id": "LD-LwqGJnRwvZPaNe5E", "uuid": "GD87TS", "serialId": 12345, "status": "Submitted", "date": "2022-01-01 10:00:00", "endDate": "2022-01-01 10:00:00", "isAllDay": true, "jobType": { "id": "JT-8718036049ec4c4d", "name": "Repair" }, "adGroup": { "id": "AG-71b8d7310acbf8cc", "name": "Ad Group 1" }, "description": "This is a description of the lead", "leadLost": true, "clientInfo": { "clientId": "CL-OvmDp2yvv1yqMwRl", "serialId": 1023, "firstName": "John Doe", "lastName": "Doe", "companyName": "Sample Company name", "email": "client@workiz.com", "primaryExt": "619", "primaryPhone": "6195555555", "secondaryExt": "613", "secondaryPhone": "6195555555", "addressDetails": { "country": "US", "state": "US", "city": "San Francisco", "zipcode": "94102", "address": "462 Powell St", "unit": "3422", "latitude": "San Francisco", "longitude": "San Francisco", "locationKey": "San Francisco" }, "serviceArea": { "id": "SA-71b8d7310acbf8cc", "name": "San Francisco" } }, "team": [ { "id": "USR-38c1ee5c4efa38a4", "name": "John Doe" } ], "tags": [ { "id": "TAG-8cddc18e7b0458fa", "name": "Estimate" } ], "customFields": [ { "id": "CF-eYLPK7198xVp6Z8q", "fieldName": "Custom Field 1", "value": "John Doe" } ], "notes": [ { "id": "JNT-8cddc18e7b0458fa", "techName": "John Doe", "note": "This is a note", "timestamp": "2022-01-01 10:00:00" } ], "statusUpdated": "2022-01-01 12:00:00", "updatedAt": "2022-01-01 12:00:00", "createdAt": "2022-01-01 10:00:00" }, "metadata": { "automationId": "auto_789", "ruleName": "New Job Notification" } }{ "trigger": { "type": "estimate_created", "timestamp": "2024-03-15T10:30:00Z" }, "data": { "id": "ES-LwqGJnRwvZPaNe5E", "status": "Pending", "serialId": "1-1", "name": "Estimate 1", "description": "This is a description for the estimate", "notes": "This is a note for the estimate", "imageUrl": "https://example.com/image.png", "clientId": "CL-LwqGJnRwvZPaNe5E", "jobId": "JOB-BA5r7o4bqzR9MONa", "discountAmount": 10, "taxPercent": 10, "taxableAmount": 100, "taxAmount": 10, "isDepositPercentage": true, "deposit": 100, "subTotal": 10, "total": 10, "declineReason": "This is a decline reason for the estimate", "lineItems": [ { "id": "ELI-BA5r7o4bqzR9MONa", "productId": 1000, "name": "Deadbolt", "description": "Deadbolt replacement, any color and size", "price": 100, "quantity": 1, "total": 100, "cost": 100, "taxable": true, "discountable": true, "inventoryManaged": true, "inventorySync": true, "optionalConverted": true } ], "payments": [ { "id": "PAY-BA5r7o4bqzR9MONa", "type": "Cash", "amount": 100, "tipAmount": 10 } ], "attachments": [ { "id": "FLE-BA5r7o4bqzR9MONa", "name": "file.pdf", "fileUrl": "https://example.com/file.pdf" } ], "signatureImage": { "id": "IMG-BA5r7o4bqzR9MONa", "signedByName": "John Doe", "imageUrl": "https://example.com/image.png" }, "sentDate": "2021-01-01", "estimateDate": "2021-01-01", "lastViewedDate": "2021-01-01", "statusUpdatedAt": "2021-01-01", "updated": "2021-01-01", "created": "2021-01-01" }, "metadata": { "automationId": "auto_789", "ruleName": "New Job Notification" } }{ "trigger": { "type": "invoice_sent", "timestamp": "2024-03-15T10:30:00Z" }, "data": { "id": "IV-bK9r2XyZL54aWDR0", "uuid": "3YBIBO", "serialId": "56", "name": "Invoice 1", "notes": "This is a note for the invoice", "jobId": "JOB-BA5r7o4bqzR9MONa", "discountAmount": 10, "subTotal": 946, "taxableAmount": 946, "taxPercent": 10.111, "taxAmount": 10.51, "costing": 10.51, "techExpenses": 12.51, "tipAmount": 43.51, "totalPrice": 956.51, "amountDue": 956.51, "amountDueDate": "2022-01-01 10:00:00", "lineItems": [ { "id": "ILI-BA5r7o4bqzR9MONa", "productId": 1000, "name": "Deadbolt", "description": "Deadbolt replacement, any color and size", "price": 100, "quantity": 1, "total": 100, "cost": 100, "taxable": true, "discountable": true, "inventoryManaged": true, "inventorySync": true, "optionalConverted": true } ], "payments": [ { "id": "PAY-BA5r7o4bqzR9MONa", "type": "Cash", "amount": 100, "tipAmount": 10 } ], "attachments": [ { "id": "FLE-BA5r7o4bqzR9MONa", "name": "file.pdf", "fileUrl": "https://example.com/file.pdf" } ], "signatureImage": { "id": "IMG-BA5r7o4bqzR9MONa", "signedByName": "John Doe", "imageUrl": "https://example.com/image.png" }, "updated": "2021-01-01", "created": "2021-01-01" }, "metadata": { "automationId": "auto_789", "ruleName": "New Job Notification" } }