Configure verified-domain webhook; secret shown once

PUT/v1/merchants/{id}/webhook

Authorization

AuthorizationBearer token (JWT) · headerrequired

Clerk human owner session JWT; iss must equal the configured Clerk issuer and the identity must be a human (not agent) owner with a verified email.

AuthorizationOAuth2 access token · headerrequired

Scopes:agentsub:owner

Path parameters

idstringrequired

Header parameters

Idempotency-Keystringrequired

Required only where this parameter is listed. Same payload/key recovers prior operation; secret replays omit plaintext.

matches ^[A-Za-z0-9._:-]{1,200}$

Request body

requiredapplication/json

urlstring<uri>required

Public HTTPS URL on the verified merchant domain or subdomain; no query, fragment or credentials

enabledboolean

default: true

Responses

200

Successful response

configurationWebhookConfiguration

Show properties

configuredboolean

enabledboolean

queueConfiguredboolean

merchantIdstring

urlstring<uri>

createdAtinteger

updatedAtinteger

webhookSecretstring

noticestring

401

unauthorized problem; live 401s advertise WWW-Authenticate: Bearer resource_metadata=...

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

403

Identity, ownership, scope or policy denied (human_required, owner_claim_required, scope_required, FROZEN, CAP_EXCEEDED, SCOPE_FORBIDDEN)

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

503

Runtime or provider configuration unavailable (runtime_configuration_required, signing_configuration_required, runtime_unavailable, workspace_unavailable, provider_configuration_required)

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

Request

curl -X PUT 'https://api.agentsub.dev/v1/merchants/string/webhook' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com",
  "enabled": true
}'

const response = await fetch("https://api.agentsub.dev/v1/merchants/string/webhook", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Idempotency-Key": "string",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"url\": \"http://example.com\",\n  \"enabled\": true\n}"
});

import requests

response = requests.put(
    "https://api.agentsub.dev/v1/merchants/string/webhook",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Idempotency-Key": "string",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"url\": \"http://example.com\",\n  \"enabled\": true\n}",
)

Response

{
  "configuration": {
    "configured": true,
    "enabled": true,
    "queueConfigured": true,
    "merchantId": "string",
    "url": "http://example.com",
    "createdAt": 0,
    "updatedAt": 0
  },
  "webhookSecret": "string",
  "notice": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}