The payload of each webhook contains information about the event in the resource key inside the payload key and will match the structure of what is returned by the corresponding API endpoint. Updated events have an additional key, previous_attributes, also inside the payload key, which represents the resource before it was updated.

The webhook request will also contain additional information such as the event type, the event source, the billing provider, and user information.

Exampletask.created event webhook payload

{
  "created_at": "2021-11-29T05:24:06.838-08:00",
  "version": "1",
  "event_source": "Web",
  "id": "2367bb67-7ffc-4e72-c553-9bef5c8d1bb5",
  "type": "task.created",
  "payload": {
    "resource": {
      "created_at": "2021-11-29T05:24:06.720-08:00",
      "updated_at": "2021-11-29T05:24:06.720-08:00",
      "id": 9999999,
      "due_date": "2021-11-29",
      "message": "Injury Failed Review",
      "links": [
        {
          "rel": "bill",
          "href": "/api/v1/bills/99999"
        },
        {
          "rel": "assigned_user",
          "href": "/api/v1/users/999999"
        }
      ]
    }
  },
  "billing_provider": {
    "id": 0
  },
  "user": {
    "email": "user@user.com"
  }
}

Supported Event Types

Type	Description
bill.created	Sent when a bill is created.
bill.deleted	Sent when a bill is deleted.
bill.updated	Sent when a bill is updated.
bill_payment.created	Sent when a bill payment is created.
bill_payment.updated	Sent when a bill payment is updated.
bill_submission.created	Sent when a bill submission is created.
billing_provider.created	Sent when a billing provider is created.
billing_provider.updated	Sent when a billing provider is updated.
contact.created	Sent when a contact is created.
contact.deleted	Sent when a contact is deleted.
contact.updated	Sent when a contact is updated.
injury.created	Sent when an injury is created.
injury.deleted	Sent when an injury is deleted.
injury.updated	Sent when an injury is updated.
injury_note.created	Sent when an injury note is created.
injury_note.deleted	Sent when an injury note is deleted.
injury_note.updated	Send when an injury note is updated.
institutional_provider.created	Sent when an institutional provider is created.
institutional_provider.deleted	Sent when an institutional provider is deleted.
institutional_provider.updated	Sent when an institutional provider is updated.
patient.created	Sent when a patient is created.
patient.deleted	Sent when a patient is deleted.
patient.updated	Sent when a patient is updated.
place_of_service.created	Sent when a place of service is created.
place_of_service.deleted	Sent when a place of service is deleted.
place_of_service.updated	Sent when a place of service is updated.
practice_contact.created	Sent when a practice contact is created.
practice_contact.deleted	Sent when a practice contact is deleted.
practice_contact.updated	Sent when a practice contact is updated.
practice_location.created	Sent when a practice location is created.
practice_location.deleted	Sent when a practice location is deleted.
practice_location.updated	Sent when a practice location is updated.
prescribing_provider.created	Sent when a prescribing provider is created.
prescribing_provider.deleted	Sent when a prescribing provider is deleted.
prescribing_provider.updated	Sent when a prescribing provider is updated.
referring_provider.created	Sent when a referring provider is created.
referring_provider.deleted	Sent when a referring provider is deleted.
referring_provider.updated	Sent when a referring provider is updated.
remittance.created	Sent when a remittance is created.
remittance.updated	Sent when a remittance is updated.
rendering_provider.created	Sent when a rendering provider is created.
rendering_provider.deleted	Sent when a rendering provider is deleted.
rendering_provider.updated	Sent when a rendering provider is updated.
request_for_authorization.created	Sent when a request for authorization is created.
request_for_authorization.deleted	Sent when a request for authorization is deleted.
request_for_authorization.updated	Sent when a request for authorization is updated.
request_for_authorization_decision.created	Sent when a request for authorization decision is created.
request_for_authorization_decision.deleted	Sent when a request for authorization decision is deleted.
request_for_authorization_decision.updated	Sent when a request for authorization decision is updated.
request_for_authorization_fax_route.created	Sent when a request for authorization fax route is created.
request_for_authorization_fax_route.deleted	Sent when a request for authorization fax route is deleted.
request_for_authorization_fax_route.updated	Sent when a request for authorization fax route is updated.
request_for_authorization_forward.created	Sent when a request for authorization forward is created.
request_for_authorization_task.completed	Sent when a request for authorization task is completed.
request_for_authorization_task.created	Sent when a request for authorization task is created.
request_for_authorization_task.updated	Sent when a request for authorization task is updated.
requesting_physician.created	Sent when a requesting physician is created.
requesting_physician.deleted	Sent when a requesting physician is deleted.
requesting_physician.updated	Sent when a requesting physician is updated.
rfa_submission.created	Sent when a request for authorization submission is created.
task.completed	Sent when a task is completed.
task.created	Sent when a task is created.
task.deleted	Sent when a task is deleted.
task.updated	Sent when a task is updated.