Webhook Endpoints

Send a test event

Changed on

Sends a real, signed example event (fake values) using the production envelope, signature scheme, and transport, and reports the outcome inline. Does not affect delivery health. Rate-limited to 10 per minute per endpoint. Investor email appears in the example only if your application holds read:investors:pii, matching what real deliveries can carry.

post/webhook_endpoints/{external_id}/test

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/webhook_endpoints/{external_id}/test
  • 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

event'investment.created' | 'investment.reinstated' | 'investment.canceled' | 'investment.converted' | 'investment.amount_changed' | 'investment.executed' | 'offering.opened' | 'offering.closing' | 'offering.closed' | 'offering.canceled' | 'investment_session.created' | 'investment_session.started' | 'investment_session.completed' | 'investment_session.expired' | 'investment_session.canceled' | 'investment.changed' | 'syndicate_member.invited' | 'syndicate_member.reinvited' | 'syndicate_member.applied' | 'syndicate_member.approved' | 'syndicate_member.joined'

Event to simulate. Defaults to the endpoint's first subscribed event.

Response

Test outcome

Example response

{
  "data": {
    "type": "webhook_test"
  }
}

Changes