Developers, API keys and webhooks
Threadkite works with the other systems you use through its API and webhooks. Settings > Developers is where owners and admins set this up. The full technical reference is in the API reference.
On Free, you can create a key that sends leads in from your website or other systems. With Pro, keys can also read and change threads, contacts and your catalogue, and webhooks tell your other systems about new leads and messages as they happen.
API keys
Section titled “API keys”An API key lets another system use Threadkite’s API on your business’s behalf.
- Go to Settings > Developers and click Create key (on Free, Create a leads key).
- Give it a Name, such as the system that will use it.
- Choose What can it do?.
- Choose Which inboxes? it can reach.
- Copy your new key straight away and keep it safe. Click I’ve copied it. You won’t see it again.
Each key shows when it was Last used. Click Revoke to stop a key working; anything using it stops straight away.
Webhooks
Section titled “Webhooks”A webhook tells your other system when something happens in Threadkite, such as a new lead or message.
- Under Webhooks, click Add endpoint.
- Enter the Endpoint URL: a web address on your system that accepts POST requests. It must start https://.
- Add a Description (optional), such as “Our accounts system”.
- Tick the Events to send.
- Copy your Signing secret, so your system can check each event came from Threadkite, and click I’ve copied it.
Open an endpoint to see its Delivery log, send a test, Pause or Resume it, or Roll secret. When you roll the secret, events are signed with both the old and new secrets for 24 hours, so you have time to update your system.
If an endpoint keeps failing, we switch it off and the endpoint says so. Fix the problem, then Turn on again.
Incoming webhooks
Section titled “Incoming webhooks”Incoming webhooks give another system an address to send its own events to, such as payments from your payment provider. Click Add address, give it a Name, and give the address to the other system.
Event log
Section titled “Event log”The Event log shows everything that happened in your business that webhooks and automations can react to. Click an event to see What it carried and Show what led to it.