Register a webhook endpoint - Lymo Platform API

POST

webhooks

curl --request POST \
  --url https://platform.lymo.jp/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": []
}
'

{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [],
    "created_at": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

承認

Authorization

string

header

必須

Unkey API key (prefix lymo_)

ボディ

application/json

url

string<uri>

必須

events

enum<string>[]

利用可能なオプション:

video.analysis.completed,

video.analysis.failed,

deal.scoring.completed,

deal.scoring.failed,

video.ready

レスポンス

201 - application/json

Webhook registered. Secret is only returned on creation.

data

object

必須

Show child attributes

meta

object

必須

Show child attributes

Delete a webhook endpoint

curl --request POST \
  --url https://platform.lymo.jp/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": []
}
'

{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [],
    "created_at": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}