Skip to main content
You configure webhooks once per workspace. Before you begin, make sure you have the workspace admin role and a publicly reachable HTTPS endpoint. See Before you start.

Create the endpoint

1

Open the webhook settings

Go to Workspace Settings > Integrations > Webhooks.If nothing is configured yet, you see No webhook configured yet.
2

Enter your endpoint URL

Type your URL into Endpoint URL. It must start with https://, for example:
Edplay rejects plain http:// URLs when you save.
3

Choose your events

Under Events, select at least one event. See Events and payloads for what each one means.
4

Leave deliveries turned on

Keep Deliveries active enabled. Turning it off pauses sending without losing your configuration.
5

Save

Click Save. Your Signing secret is generated on this first save and appears below the form.
6

Store the signing secret

Copy the secret into your application configuration and treat it like any other credential. Your receiver needs it to verify signatures.
7

Send a test event

Click Send test event, then check the delivery log. A row with the status Delivered confirms your endpoint is reachable and responding correctly.
You can change the endpoint URL or the event selection at any time. The signing secret stays the same unless you rotate it deliberately.

Test your endpoint

Send test event delivers a sample payload so you can confirm your endpoint is reachable and your signature check passes before real learner activity depends on it. Two things to expect:
  • The test is queued rather than sent inline, so its row appears in the delivery log a moment after you click the button. Click Refresh if it is not there yet.
  • The test payload has a different shape from a real event. See The test payload.
Send test event is only available once you have saved an endpoint. Until then you see Save an endpoint before sending a test event.

Rotate the signing secret

Rotate secret issues a new signing secret and invalidates the old one immediately. There is no overlap period, so any receiver still verifying with the old secret rejects deliveries until you update it. To rotate without dropping events:
1

Pause deliveries

Turn Deliveries active off and click Save. Events stop being sent.
2

Rotate the secret

Click Rotate secret and confirm in the dialog.
3

Update your application

Copy the new secret into your configuration and deploy the change.
4

Resume deliveries

Turn Deliveries active back on and click Save.
5

Confirm

Click Send test event and check that the new secret verifies.
Events that occur while deliveries are paused are not queued for later. Keep the pause window as short as you can, and backfill through the API if you miss anything.

Pause deliveries

Turning Deliveries active off keeps your URL and event selection intact but stops all sending. Use it for planned maintenance on your side rather than deleting the configuration. Next: Events and payloads