Updates a webhook

PATCH

/webhook/{name}

curl --request PATCH \
  --url https://web.exactly.app/api/webhook/example \
  --header 'Content-Type: application/json' \
  --cookie __Secure-better-auth.session_token=<__Secure-better-auth.session_token> \
  --data '{ "url": "https://example.com", "transaction": { "created": "https://example.com", "updated": "https://example.com", "completed": "https://example.com" }, "card": { "updated": "https://example.com" }, "user": { "updated": "https://example.com" } }'

• Production
• Sandbox

Partially updates an existing webhook by name. Only fields included in the request body are modified; omitted fields (including the top-level url and any nested per-event URLs) keep their stored value. Passing null for a per-event URL clears it; the parent group is dropped when it has no per-event URLs left. Returns 400 when the path name fails the slug pattern, the body fails validation, or any URL uses a non-https scheme, fails to resolve, or resolves to a private/loopback address. Returns 404 when the organization has no source configured or no webhook with that name exists. The signing secret is preserved and is not returned in the response. Only owner and admin roles can update a webhook.

Authorizations

• siweAuth

Parameters

Path Parameters

name

required

string

/^[a-z0-9-]{1,64}$/

Request Body

Media typeapplication/json

object

url

string format: uri

transaction

object

created

Any of:

string

string format: uri

nullable

updated

Any of:

string

string format: uri

nullable

completed

Any of:

string

string format: uri

nullable

card

object

updated

Any of:

string

string format: uri

nullable

user

object

updated

Any of:

string

string format: uri

nullable

Example^generated

{
  "url": "https://example.com",
  "transaction": {
    "created": "https://example.com",
    "updated": "https://example.com",
    "completed": "https://example.com"
  },
  "card": {
    "updated": "https://example.com"
  },
  "user": {
    "updated": "https://example.com"
  }
}

Responses

200

Webhook updated

Media typeapplication/json

object

url

required

string format: uri

transaction

object

created

string format: uri

updated

string format: uri

completed

string format: uri

card

object

updated

string format: uri

user

object

updated

string format: uri

name

required

string

/^[a-z0-9-]{1,64}$/

Example^generated

{
  "url": "https://example.com",
  "transaction": {
    "created": "https://example.com",
    "updated": "https://example.com",
    "completed": "https://example.com"
  },
  "card": {
    "updated": "https://example.com"
  },
  "user": {
    "updated": "https://example.com"
  },
  "name": "example"
}

400

Invalid webhook name, body, or URL

Media typeapplication/json

object

code

required

string

message

Array<string>

Example

{
  "code": "invalid name"
}

401

Unauthorized

Media typeapplication/json

object

code

required

Allowed values: unauthorized

Example

{
  "code": "unauthorized"
}

403

User doesn't belong to the organization

Media typeapplication/json

Any of:

object

object

code

required

Allowed values: no organization

object

object

code

required

Allowed values: no permission

Example

{
  "code": "no organization"
}

404

Webhook not found

Media typeapplication/json

object

code

required

Allowed values: not found

Example

{
  "code": "not found"
}