Skip to main content

Disclaimer

Webhook setup and configuration must be facilitated by FieldPulse Support.

Payload Envelope

All outbound webhook requests use this top-level JSON envelope:

data Variants

Depending on trigger configuration, data is one of:
  1. Object-only payload
2. Change payload (field/subfield updates)

Jobs

1) New Job Creation

  • Event Name: Job Created
  • Example Payload Schema:

2) Job Status Update

  • Event Name: Job Custom Status Update
  • Event Name: Job Workflow Custom Status Update
  • Example Payload Schema:

3) Job Schedule/Date Time Edit (Reschedule)

  • Event Name: Job Start Time Update
  • Event Name: Job End Time Update
  • Example Payload Schema:

Estimates

1) New Estimate Creation

  • Event Name: Estimate Created
  • Example Payload Schema:

2) Estimate Status Update

  • Event Name: Estimate Custom Status Update
  • Event Name: Estimate Workflow Custom Status Update
  • Example Payload Schema:

Invoices

1) New Invoice Creation

  • Event Name: Invoice Created
  • Example Payload Schema:

2) Invoice Status Update

  • Event Name: Invoice Custom Status Update
  • Event Name: Invoice Workflow Custom Status Update
  • Example Payload Schema:

Maintenance Agreements

1) Maintenance Agreement Created

  • Event Name: Maintenance Agreement Created
  • Example Payload Schema:

3) Maintenance Agreement Custom Status Update

  • Event Name: Maintenance Agreement Custom Status Update
  • Example Payload Schema:

Customers

1) Customer Created

  • Event Name: Customer Created
  • Example Payload Schema:

2) Customer Status Update

  • Event Name: Customer Status Update
  • Example Payload Schema:

3) Customer Pipeline Status Update

  • Event Name: Customer Pipeline Status Update
  • Example Payload Schema:

Material Lists

1) Material List Created

  • Event Name: Material List Created
  • Example Payload Schema:

2) Material List Custom Status Update

  • Event Name: Material List Custom Status Update
  • Example Payload Schema:

Projects

1) Project Created

  • Event Name: Project Created
  • Example Payload Schema:

2) Project Custom Status Update

  • Event Name: Project Custom Status Update
  • Example Payload Schema:

Purchase Orders

1) Purchase Order Created

  • Event Name: Purchase Order Created
  • Example Payload Schema:

2) Purchase Order Custom Status Update

  • Event Name: Purchase Order Custom Status Update
  • Example Payload Schema: