Create a webhook endpoint

Adds an endpoint that receives processing events, and returns its signing secret. The URL is checked: in production it must use https, and it must not resolve to a private or internal address.

POST
/settings/webhooks/create
Serverhttps://api.medialit.cloud
Authentication
Body

Authentication

  • Bearer token (JWT)

  • Or API key in the x-medialit-apikey header

Request body

application/json
required
  • urlstring
    required

    Receiving URL. Must use https in production.

  • eventsarray<string>

    Events to send. Defaults to every event.

  • enabledboolean

    Defaults to true.

Responses

201
Endpoint created
  • idstring
    required
  • urlstring
    required
  • eventsarray<string>
    required

    Events to send. Defaults to every event.

  • enabledboolean
    required
  • secretHintstring
    required

    The signing secret's last characters.

  • secretstring

    Signing secret (Standard Webhooks). Returned only when the endpoint is created or its secret rotated; read it with POST /settings/webhooks/secret.

  • createdAtstring (date-time)
    required
  • updatedAtstring (date-time)
    required
400
Bad Request
  • errorstring
    required
401
Unauthorized
  • errorstring
    required
403
Forbidden
No response body.
409
The app has the most endpoints allowed
  • errorstring
    required
500
Internal Server Error
  • errorstring
    required