API Reference

Create webhook subscription

post
https://api.gridverify.com/webhooks/subscription

While polling the GET /insights endpoint is possible, it is often preferable to have the insights response pushed to the customer as soon as they're ready.

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

The uuid of the customer/company for which the subscription is being created

string
enum
required

The environment for which the subscription is being created

Allowed:
string
required

The URL to which the webhook will send requests

workflowIds
array of strings
required

The workflow IDs that this subscription will be associated with. Will be ignored if allWorkflows is set to true

workflowIds*
boolean
required

Whether the subscription should be applied to all workflows that belong to the customer. If set to true, the workflowIds field is ignored

Responses

Updated 4 months ago

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

Updated 4 months ago