Skip to main content
The payload structure depends on your destination type:
  • Webhook destinations: Payloads include notificationType and data fields.
  • Kinesis destinations: Payloads contain the data object. The notificationType is included in the event metadata.
Webhook destination payload:
{
  "notificationType": "installation.created",
  "data": {
    "projectId": "uuid",
    "provider": "salesforce",
    "integrationId": "uuid",
    "integrationName": "Salesforce Integration",
    "installationId": "uuid",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "config": {
      "read": {
        "objects": {
          "Account": {
            "objectName": "Account",
            "destination": "my-webhook",
            "requiredFields": [...],
            "optionalFields": [...]
          }
        }
      }
    }
  }
}
Kinesis destination payload:
{
  "projectId": "uuid",
  "provider": "salesforce",
  "integrationId": "uuid",
  "integrationName": "Salesforce Integration",
  "installationId": "uuid",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "config": {
    "read": {
      "objects": {
        "Account": {
          "objectName": "Account",
          "destination": "my-webhook",
          "requiredFields": [...],
          "optionalFields": [...]
        }
      }
    }
  }
}
Note: config contains the complete installation configuration object including read, write, subscribe, and proxy settings. installation.updated includes an additional lastConfig field with the previous configuration.
Webhook destination payload:
{
  "notificationType": "read.backfill.done",
  "data": {
    "projectId": "uuid",
    "provider": "salesforce",
    "integrationId": "uuid",
    "integrationName": "Salesforce Integration",
    "installationId": "uuid",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "objectName": "Account"
  }
}
Kinesis destination payload:
{
  "projectId": "uuid",
  "provider": "salesforce",
  "integrationId": "uuid",
  "integrationName": "Salesforce Integration",
  "installationId": "uuid",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "objectName": "Account"
}
Webhook destination payload:
{
  "notificationType": "read.schedule.paused",
  "data": {
    "projectId": "uuid",
    "provider": "salesforce",
    "integrationId": "uuid",
    "integrationName": "Salesforce Integration",
    "installationId": "uuid",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "config": {
      "read": {
        "objects": {
          "Account": {
            "objectName": "Account",
            "destination": "my-webhook",
            "requiredFields": [...],
            "optionalFields": [...]
          }
        }
      }
    },
    "error": "Error message if applicable"
  }
}
Kinesis destination payload:
{
  "projectId": "uuid",
  "provider": "salesforce",
  "integrationId": "uuid",
  "integrationName": "Salesforce Integration",
  "installationId": "uuid",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "config": {
    "read": {
      "objects": {
        "Account": {
          "objectName": "Account",
          "destination": "my-webhook",
          "requiredFields": [...],
          "optionalFields": [...]
        }
      }
    }
  },
  "error": "Error message if applicable"
}
Note: config contains the complete installation configuration object including read, write, subscribe, and proxy settings.
Webhook destination payload:
{
  "notificationType": "connection.created",
  "data": {
    "projectId": "uuid",
    "connectionId": "uuid",
    "provider": "salesforce",
    "groupRef": "customer-group-ref",
    "consumerRef": "user-123",
    "consumerName": "John Doe"
  }
}
Kinesis destination payload:
{
  "projectId": "uuid",
  "connectionId": "uuid",
  "provider": "salesforce",
  "groupRef": "customer-group-ref",
  "consumerRef": "user-123",
  "consumerName": "John Doe"
}