Test a Webhook

Build a mocked alert for a borrower and product (daily | monthly) using the lender's selected attributes with fake values, deliver it to the customer's monitoring webhook subscription(s) for that product, and return the delivered payload along with per-subscription delivery results. A subscription for the product must exist first (create one via POST /monitor/webhook).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This is useful a way of simulating webhooks being sent by Grid such that client processing of webhooks can be tested.

Body Params
string
required

The borrower to mock an alert for. Must belong to the calling customer.

string
enum
required

The monitoring product to mock an alert for

Allowed:
boolean

When true, persist the generated mock alert to the alert table so it appears in GET /monitor/alerts. Only supported in non-production environments; rejected with a 400 in production.

Headers
string
required

The environment specific API Key to access the API

Responses

403

The creditMonitoring module is not enabled for this customer

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json