API and webhooks
API and webhooks so your data can talk to your systems
With the DeepMiner API, your systems send JSON records to an index, authenticated with the login token, and the import shows up in the history with API as its source. Each user can also generate API keys for the integration API. In the other direction, every configured provider gets its own webhook URL: status events arrive through it, find the matching record and update its status, with the latest events kept on each record.
What you do
Import through the API, a per-user API key for integration and a return webhook for each provider.
-
One API key per user
Each user generates their own keys on the API Key screen to use on the integration API. The key carries the user's partner, so the integration only sees that partner's data.
-
Import through the API
With the login token, send a list of JSON records to an index. They follow the schema, the key field prevents duplicates and progress shows up just like a file import.
-
One webhook URL per provider
The URL is created with a random token and shown only once. DeepMiner stores only a signature of the token, and regenerating it invalidates the previous URL.
-
Results land on the right record
Each event is matched to the record it came from. The channel status, the update date and the event fields defined for that provider type go onto the record, and the event goes into its history.
-
A log for every event
The webhook log shows each event received as processed, duplicate, unmatched or failed, with the payload for review.
Inbound: records through the API
When your data starts in another system, the API saves you a manual export. The system authenticates with a user’s login token, sends the records as JSON to the index, and the import follows the same path as a file: validation against the schema, updates by key field and tracked progress. In the Import History, the source shows as API.
The API key, generated by each user on the API Key screen, is the credential for the integration API and carries the user’s partner. One partner’s data never shows up for another, through the API or the interface.
Outbound: the result of every send
When you configure a provider, DeepMiner generates its webhook URL and shows it once so you can copy and paste it into the provider’s panel. After that, the token is not shown again. If you need to change it, Regenerate token creates another one and the previous URL stops working.
Each incoming event is placed in a queue and processed right after. DeepMiner checks that the provider is still active, finds the record by the send reference or by the message identifier, and updates the channel status. The record history keeps the latest events, and repeated events are not applied twice.
What this changes in the operation
With the result inside the record, the status of every send shows up in the index’s record list and in the Provider events history. The return spreadsheet exported from the provider’s panel is no longer needed to check who received what.
Frequently asked questions
API and webhooks
How do I authenticate on the API?
Importing through the API uses the user's login token. The API key, generated on the API Key screen, is for the integration API. Both belong to a user and are restricted to that user's partner.
Does the webhook respond quickly to the provider?
Yes. Receiving only checks the token and puts the event in a queue. Processing happens right after, outside the provider's request.
What if the provider sends the same event twice?
DeepMiner recognizes the repeated event and records it as a duplicate, without applying the same update again.
Can one partner see another partner's data through the API?
No. The platform is multi-tenant and every call is restricted to the user's partner.
Where do I see the events of a record?
In the record detail, in the Provider events section, with the status and payload of each event.
See DeepMiner working on your data.
Book a demo and watch a dataset get indexed, enriched and queried.