v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Update Webhook Endpoint

update an exisiting webhook endpoint

patch/webhook_endpoints/{id}

Path parameters

idstring required

An ID for a webhook endpoint to be updated

Request body

urlstring

new url must start with https

configured_eventsobject

hash of events and event names, empty for all events. list of events found here: https://app.moderntreasury.com/developers/webhooks/new

enabledboolean

true if enabled, false if paused

Response

200

idstring

objectstring

live_modeboolean

urlstring

enabledboolean

{"stackTrail":"paths:/webhook_endpoints/{id}:patch:responses:200:content:application/json:schema:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "4c2cf019-584d-40dc-9745-4e3f1c9ac4b9",
  "object": "webhook_endpoint",
  "url": "https://<your-domain.com>",
  "configured_events": {
    "paper_item": [
      "created"
    ],
    "incoming_payment_detail": [
      "tentatively_reconciled"
    ]
  },
  "enabled": true,
  "created_at": "2022-02-16T02:23:40Z",
  "updated_at": "2022-02-16T02:27:38Z"
}