Sign in
Webhook Endpoints

Create a webhook endpoint

Changed on

Registers an endpoint for your application. The response is the only time the signing secret is returned; store it to verify signatures. Requires an owner, admin, or developer role in the application's organization.

On the sandbox API this returns 403 manage_endpoints_on_live_api: create test endpoints through the live API with mode: "test", and they are mirrored into sandbox.

post/webhook_endpoints

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/webhook_endpoints
  • 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)

Request body

urlstring uri required

Public HTTPS URL to receive deliveries (private/internal IPs rejected).

eventsstring[] required

Event names to subscribe to (from the event catalog). At least one.

mode'live' | 'test'

Example request

{
  "url": "https://yourapp.com/webhooks/wefunder",
  "events": [
    "offering.opened",
    "investment.executed"
  ]
}

Response

Endpoint created (includes the one-time secret)

Example response

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

Changes