Skip to main content
POST
/
webhooks
Register a webhook endpoint
curl --request POST \
  --url https://edpire.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": []
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "secret": "<string>"
  },
  "error": {
    "message": "<string>"
  },
  "meta": {}
}

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
object
​
meta
object