Notification payloads

Installation events (created, updated, deleted)

Webhook destination payload:

{
  "notificationType": "installation.created",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "config": { //If the config content is too large, the config field will be empty and you can retrieve the content from the URL provided in `configURL`.
      "read": {
        "objects": {
          "account": {
            "objectName": "account",
            "destination": "my-webhook",
            "requiredFields": [...],
            "optionalFields": [...]
          }
        }
      }
    },
    "lastConfig": { // Only for `installation.updated` notifications. If the config is too large, it will be omitted and the content will be available in `lastConfigURL`.
      "read": {
        "objects": {
          "account": {
            "objectName": "account",
            "destination": "my-old-webhook",
            "requiredFields": [...],
            "optionalFields": [...]
          }
        }
      }
    }
    // "lastConfigURL": "https://example.com/lastconfig.json"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "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.

read.backfill.done

Webhook destination payload:

{
  "notificationType": "read.backfill.done",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "objectName": "Account"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "objectName": "Account"
}

read.schedule.paused

Webhook destination payload:

{
  "notificationType": "read.schedule.paused",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "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": "Authentication failed"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "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": "Authentication failed"
}

Note: config contains the complete installation configuration object including read, write, subscribe, and proxy settings.

read.triggered.done

Webhook destination payload:

{
  "notificationType": "read.triggered.done",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "objectName": "Account",
    "fromTimestamp": "2026-01-01T00:00:00Z",
    "untilTimestamp": "2026-01-01T23:59:59Z"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "objectName": "Account",
  "fromTimestamp": "2026-01-01T00:00:00Z",
  "untilTimestamp": "2026-01-01T23:59:59Z"
}

Note: fromTimestamp and untilTimestamp indicate the time range of the triggered read.

read.triggered.error

Webhook destination payload:

{
  "notificationType": "read.triggered.error",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "objectName": "Account",
    "fromTimestamp": "2026-01-01T00:00:00Z",
    "untilTimestamp": "2026-01-01T23:59:59Z",
    "error": "Authentication failed"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "objectName": "Account",
  "fromTimestamp": "2026-01-01T00:00:00Z",
  "untilTimestamp": "2026-01-01T23:59:59Z",
  "error": "Authentication failed"
}

Note: error describes what went wrong during the triggered read.

write.async.done

Webhook destination payload:

{
  "notificationType": "write.async.done",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "objectName": "Account",
    "success": true,
    "successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"],
    "errors": []
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "objectName": "Account",
  "success": true,
  "successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"],
  "errors": []
}

Note: For partial failures, success is false with both successfulRecordIds and errors populated.

Webhook destination payload:

{
  "notificationType": "subscribe.create.error",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "provider": "salesforce",
    "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "integrationName": "Salesforce Integration",
    "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "groupRef": "customer-group-ref",
    "groupName": "Customer Name",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "error": "provider returned 403: insufficient access to EventChannelMember"
  }
}

Kinesis destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "provider": "salesforce",
  "integrationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "integrationName": "Salesforce Integration",
  "installationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "groupRef": "customer-group-ref",
  "groupName": "Customer Name",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "error": "provider returned 403: insufficient access to EventChannelMember"
}

Connection events (created, refreshed, updated, deleted)

connection.created, connection.refreshed, connection.updated, and connection.deleted share the same payload shape. notificationType reflects the specific event.Webhook destination payload:

{
  "notificationType": "connection.created",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "provider": "salesforce",
    "groupRef": "customer-group-ref",
    "consumerRef": "user-123",
    "consumerName": "John Doe"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "provider": "salesforce",
  "groupRef": "customer-group-ref",
  "consumerRef": "user-123",
  "consumerName": "John Doe"
}

connection.error

The error field is deprecated and kept for backward compatibility. Use errors instead. Both fields contain the same value.

Webhook destination payload:

{
  "notificationType": "connection.error",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
    "provider": "salesforce",
    "groupRef": "customer-group-ref",
    "consumerRef": "user-123",
    "consumerName": "John Doe",
    "errors": ["Authentication failed", "Token refresh error"],
    "error": ["Authentication failed", "Token refresh error"]
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "connectionId": "c4e7f2a1-8b3d-4f6e-9a2c-5d1e3f4b6a7c",
  "provider": "salesforce",
  "groupRef": "customer-group-ref",
  "consumerRef": "user-123",
  "consumerName": "John Doe",
  "errors": ["Authentication failed", "Token refresh error"],
  "error": ["Authentication failed", "Token refresh error"]
}

destination.webhook.disabled

Webhook destination payload:

{
  "notificationType": "destination.webhook.disabled",
  "data": {
    "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
    "destinationId": "2e8f4c1a-9b3d-4e7f-8a2c-0d1e2f3a4b5c",
    "destinationName": "production-alerts",
    "url": "https://your-webhook.com"
  }
}

Kinesis and S3 destination payload:

{
  "projectId": "8f4a2b1c-3d5e-4f6a-9b0c-1d2e3f4a5b6c",
  "destinationId": "2e8f4c1a-9b3d-4e7f-8a2c-0d1e2f3a4b5c",
  "destinationName": "production-alerts",
  "url": "https://your-webhook.com"
}