Webhooks & SFTP Transfers
At Thought Industries, we are focused on providing access to your learning data in as many ways as possible. Below, see the primary methods available to have TI send learning data to your organization on an automated schedule. If you prefer to pull data out of TI instead of having it pushed to you, check out our API Documentation.
Webhooks
A webhook is a realtime notification sent to your web server whenever an action occurs in the TI platform. For example, a learner completes a course within TI and you receive a realtime notification. You can then pass this event onward to any third party reporting/analytics system.
- Choose which event(s) you would like to get notified of. Payload of event data is posted in real-time in JSON format to the appropriate URL. Payloads are identical to the events found within our API Documentation.
- You receive payload data and can transform the payload into format consumable by enterprise software / email marketing systems. This may require technical team to write necessary scripts.
- The connection will time out in 15 seconds. If your endpoint does not respond before the connection times out or if your endpoint returns a status code outside the range of 200–308, we will consider the delivery of the message as a failed attempt.
- If webhook delivery fails, we will automatically retry over time. We will retry ten times total with an exponential backoff starting from 20 seconds up to 3600 seconds, giving up approximately 3.5 hours after the first webhook delivery attempt.
SFTP Transfers
An SFTP Transfer is a nightly transfer of events from TI to a secure client FTP (SFTP) in CSV or JSON format. For example, every night on an automated basis, you could receive a file containing all course completions that occurred over the previous day.
- Choose which event(s) you would like to get notified of. All events which occurred over the previous day will be posted at ~2am everyday. Files can be in either CSV or JSON format. Contents of files are identical to the events found within our API Documentation.
- SFTP transfers are fired at roughly 2am (based on the configured time zone) and will contain all events from the previous day. For example, the SFTP transfer sent at 2am on Friday will contain all of Thursday’s events.
- Files can be automatically detected and transformed into a format consumable by enterprise software / email marketing systems, or can be manually processed asynchronously.
- The connection will time out in 60 seconds. If your server does not respond before the connection times out, or takes longer than 5 minutes total to transfer the file, we will consider the delivery of the message as a failed attempt.
- If SFTP transfer delivery fails, we will automatically retry over time. We will retry ten times total with an exponential backoff starting from 20 seconds up to 3600 seconds, giving up approximately 3.5 hours after the first SFTP transfer attempt.