Skip to main content
POST
/
api
/
webhooks
Register Webhook
curl --request POST \
  --url https://api.legitmark.com/api/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-token: <api-key>' \
  --data '
{
  "url": "https://actor-platform.com/legitmark-webhook",
  "events": [
    "state_change"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": {}
}

Authorizations

​
x-api-key
string
header
required

Actor API key for application authentication (format: leo_xxxxxxxxx)

​
x-user-token
string
header
required

Secure user token (Non-PII format: lm_usr_xxxxx)

Body

application/json
  • Option 1
  • Option 2
​
url
string<uri>
required

Actor webhook endpoint URL

Example:

"https://actor-platform.com/legitmark-webhook"

​
events
enum<string>[]
required

List of events to subscribe to

Response

Webhook registered successfully

​
success
boolean
Example:

true

​
message
string
​
data
object