Generate a test event notification

post

https://gateway.stage.bill.com/connect-events/v3/subscriptions/{subscriptionId}/test

Generate a new test event notification. After you create a subscription, use this endpoint for BILL to send a test event notification to your specified notification URL.

In your request, all the fields are optional. To see specific information in the test event notification, you can set eventType, version, and any details. You can get the BILL events catalog with GET /v3/events/catalog.

Note: All the fields in the test event notification are test values. You cannot use any of the test values for any other operation.

See Webhooks in the Guides section for more information, sample requests, and notification payloads for BILL events.

Path Params

subscriptionId

string

required

length ≥ 1

BILL-generated ID of the subscription

Body Params

eventType

string

Event type. You can get the BILL events catalog with GET /v3/events/catalog.

version

string

Event type version

vendor

object

Test vendor event payload

bill

object

Test bill event payload

bank-account

object

Test bank-account event payload

card-account

object

Test card-account event payload

payment

object

Test payment event payload

risk-verification

object

Test risk-verification event payload

invoice

object

Test invoice event payload

transaction

object

Test spend.transaction event payload

threeDsChallenge

object

Test spend.threeDsChallenge event payload

reimbursement

object

Test spend.reimbursement event payload

Headers

sessionId

string | null

API session ID generated with /v3/login

devKey

string | null

Developer key sent to you by BILL when you create a developer account. Set sessionId and devKey for organization-level BILL v3 API webhook events.

appKey

string | null

Application key sent to you by BILL when you create a partner account. Set sessionId and appKey for partner-level BILL v3 API webhook events.

apiToken

string | null

Access token for Spend & Expense API authentication. Set apiToken for Spend & Expense webhook events.

Response

200sendTestEvent 200 response