Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

API key starting with edp_live_. Pass via Authorization: Bearer edp_live_xxx.

Scopes: read:assessments, write:assessments, read:results, write:submissions.

Body

application/json
url
string<uri>
required

HTTPS URL (http://localhost allowed for dev)

events
enum<string>[]
required
Minimum array length: 1
Available options:
submission.graded,
assessment.published,
assessment.archived,
assessment.updated,
collection.created,
collection.updated,
collection.deleted,
collection.item_added,
collection.item_removed,
collection.reordered

Response

Webhook registered (secret included)

data
object
error
null | object
meta
null | object