In this article, you will learn how to create new webhooks using Workiz Automations.

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 webhook automations

To set up a webhook, head to the Workiz Automation Center. You’ll create a rule by selecting a trigger event, defining any conditions you need, and adding a webhook as the action. When that rule runs, Workiz will send the relevant data to your specified endpoint instantly.

1. From the top navigation bar, select Automations
2. Select Add automation
3. Select this happens and choose a job- or lead-based trigger (e.g., when a job is created, when a lead is rescheduled, etc.)
4. Select do this and choose post webhook
   
5. Select add URL and configure your webhook:
   1. URL: Enter the endpoint you want to post the webhook to
   2. (Optional) Auth key: Enter the authentication key that will be sent in the authorization header as a Bearer token
   3. Select Save
6. (Optional) Add any conditions you want to apply to this automation rule (e.g., only if job type is X, only if ad source is not Y, etc.)
7. Select Add automation

Payload examples

Workiz currently offers webhooks for both lead- and job-based events. Support for estimate- and invoice-based events will be made available soon. 

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"
    }
  }