Sign in
Webhook Endpoints

Update a webhook endpoint

Changed on

events replaces the subscription list wholesale (no merge); omit it to leave it unchanged. An endpoint must subscribe to at least one event, so [] and null are rejected; delete the endpoint to stop all deliveries. Requires an org management role. Returns 403 manage_endpoints_on_live_api on the sandbox API; use the live API.

patch/webhook_endpoints/{external_id}

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/webhook_endpoints/{external_id}
  • Auth: OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: write:webhooks)

Path parameters

external_idstring required

The webhook endpoint's id (whe_...).

Request body

urlstring uri
eventsstring[]

Response

Updated endpoint (secret omitted)

Example response

{
  "data": {
    "id": "whe_8f3ExampleEndpoint00",
    "type": "webhook_endpoint",
    "attributes": {
      "last_delivery_status": "200"
    }
  }
}

Changes