Account Links Export

The Account Links export provides linkages between authentication IDs and source system user identities.

Requesting Access

To request access to account links exports for your integration, please contact customer support with the following information:

• Client ID
• Preferred destination (S3, etc.)
• Desired export frequency

Export Destinations

Exports can be delivered to the following destinations:

Amazon S3

• Direct delivery to your S3 bucket
• Requires: bucket name, region, and appropriate IAM permissions
• Primary destination for all exports
• See S3 Destination

Other Destinations

Additional destinations may be available in future releases. Contact customer support to discuss your specific requirements or request new destination types.

Export Types

Full vs Differential Exports

Differential Exports: Each export contains only records that have been created or modified since the last successful export. The system uses a checkpoint mechanism to track the last export timestamp per client and only includes records with last_modified > last_checkpoint.

Full Exports: Full historical exports are available upon request. Contact customer support if you require a complete snapshot of all account link data regardless of modification date.

Export Scheduling

Exports can be configured to run at the following intervals:

• Hourly: Every hour at a specified minute
• Daily: Once per day at a specified time (UTC)
• Weekly: Once per week on a specified day and time (UTC)
• Custom: Contact customer support for custom scheduling requirements. We use Cron for scheduling: https://crontab.guru/

Data Formats

All account links exports are delivered as JSON files.

Export Samples

Account Links Export

The account links export contains mappings between authentication IDs and source system user identities, including metadata and link status.

Sample Export:

[
  {
    "id": 78901,
    "auth_id": 12345,
    "client": "DEMOCLIENT",
    "source_system_id": "SALESFORCE",
    "source_system_user_id": "0031X00001AbCdEQAV",
    "source_system_created_at": "2023-05-15T08:30:00.000Z",
    "alias": "[email protected]",
    "metadata": {
      "accountType": "premium",
      "region": "NA",
      "migrationSource": "legacy_system"
    },
    "created_at": "2024-01-10T09:15:30.000Z",
    "last_modified": "2024-03-20T14:25:30.000Z",
    "primary": true
  },
  {
    "id": 78902,
    "auth_id": 12345,
    "client": "DEMOCLIENT",
    "source_system_id": "DYNAMICS",
    "source_system_user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "source_system_created_at": "2023-08-22T12:00:00.000Z",
    "alias": "jdoe",
    "metadata": null,
    "created_at": "2024-02-05T11:20:15.000Z",
    "last_modified": "2024-02-05T11:20:15.000Z",
    "primary": false
  },
  {
    "id": 78903,
    "auth_id": 67890,
    "client": "DEMOCLIENT",
    "source_system_id": "TICKETMASTER",
    "source_system_user_id": "TM-USER-98765",
    "source_system_created_at": null,
    "alias": "[email protected]",
    "metadata": {
      "accountType": "standard",
      "verified": true
    },
    "created_at": "2024-03-18T16:45:00.000Z",
    "last_modified": "2024-03-22T09:30:45.000Z",
    "primary": true
  }
]

Field Descriptions:

Best Practices

1. Differential Processing: Exports are differential by default. Design your integration to process incremental updates and maintain a local copy of the full dataset
2. First Export: The first export will contain all historical records. Subsequent exports will only include changes
3. Data Processing: Always validate the JSON structure before processing exports
4. Error Handling: Implement retry logic for failed export retrievals
5. Monitoring: Set up alerts for missing or delayed exports
6. Date Handling: All timestamps are in UTC; convert to your local timezone as needed
7. Primary Links: Use the primary flag to identify the primary account link when multiple links exist for the same auth_id
8. Null Handling: Be prepared to handle null values in optional fields like metadata and source_system_created_at

Troubleshooting

Export Not Received

• Verify your destination credentials are current
• Check that your destination has sufficient storage space
• Review any firewall or security rules that might block the delivery

Missing Historical Data

• Exports are differential by default - you'll only receive changes since the last export
• To receive all historical data, contact support to reset your export checkpoint

Data Discrepancies

• Ensure you're processing the most recent export file
• Verify timezone handling for date fields
• Contact customer support if data appears incorrect

Empty Exports

• Empty exports are normal when no account link changes have occurred since the last export
• This indicates stable data with no new links or modifications for the export period