Structure

ON THIS PAGE

There are 3 models that invoke webhooks - Project, Contact and Event

The webhook payload has the following structure:

• timestamp: A timestamp of when the event occured.
• identifier: A unique identifier which can be set by the creator or automatically generated by OpenSolar. Typically used to store the primary key from an external integration, such as a SalesForce Object Id.
• model: The model that triggered the webhook.
• model_id: The primary key of the model instance.
• event: CREATE, UPDATE, DELETE
• event_id: The id of this particular webhook event.
• fields: Contains the fields that are part of the model. Note this is only for CREATE/UPDATE.

Example

Base Structure:

{
  "timestamp": "1605831713",
  "model": "Project",
  "model_id": 1,
  "identifier": "6ab6a60d-1a4d-4374-88af-92f7c02e3223",
  "event": "UPDATE",
  "event_id": 1,
  "fields": {
    ...
  }
}