Sign in
Webhook

Register or update a merchant webhook URL

Register or update a merchant webhook URL

post/api/v1/webhooks

Request body

merchant_idstring uuid

Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.

webhook_urlstring uri required

The URL where webhook notifications will be sent

Example request

{
  "merchant_id": "550e8400-e29b-41d4-a716-446655440000",
  "webhook_url": "https://example.com/webhook"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "webhook_url": "https://example.com/webhook",
    "message": "Webhook URL successfully configured"
  }
}

Changes

Changed in 3 of the 8 revisions of this API.214

  • b372e7d5563d113See the full diff
    • ▲

      the error/code response's property type/format changed from string/ to / for status 400

      response-property-type-changed

    • ●

      removed the optional property error/errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added the new optional request property merchant_id

      new-optional-request-property

    • ○

      added the optional property error/metadata to the response with the 400 status

      response-optional-property-added

    • ○

      added subschema #1 subschema #2 to the error/code response property allOf list for the response status 400

      response-property-all-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog