How do I send events to another system?

Where: Settings → Advanced → Connect other apps

Open this page: admin.<your-site>/settings/integrations/webhooks (replace <your-site> with your site address). If you don’t see it in the menu, turn on Show all settings on the Settings page.

Before you start

• Only the site owner can add webhooks.
• The receiving address must start with https:// and be on the public internet.

Steps

1. Open Settings → Advanced → Connect other apps → Webhooks.
2. Press Add webhook.
3. Enter a Name, for example Zapier, and the Address that receives the messages.
4. Under Send me a message when, tick events: A story goes live, A live story is changed, A story is taken down, A correction is added, A story is retracted, A new comment, A subscription changes.
5. Press Add webhook.
6. Copy the signing secret. You see it once. Press I saved it.
7. Try Send test event.

Good to know

• Every message is signed. Check the "Keynate-Signature" header to be sure it came from your site.
• Your system answers with any 2xx status to say it got the message.
• Failed messages are tried again for up to 24 hours. A webhook that fails for 3 days is switched off. Fix the receiver, then press Resume.
• You can Pause, Resume, or make a New secret. The old secret keeps signing for a while you choose.
• The list shows each webhook's state: Working, Not used yet, Not working, Paused, Switched off.
• Open a sent message to see the tries and press Send again.

Common problems

• "The address must start with https://."
• "Give the webhook a name."
• "Choose at least one event."
• "You have reached the number of webhooks you can have. Delete one you no longer use first."

Questions

Related

• Connect other apps
• API keys