Skip to Content
FlowVerifyDevelopers

Create a webhook subscription

Scope webhooks:manage. The endpoint must be a public http(s) URL (HTTPS in production; private, loopback and cloud-metadata addresses are refused). The signing secret is returned once in this response. At most 20 webhooks per organization.

Authorization

apiKey
headerAuthorizationBearer <fv_live_… or fv_test_…>

Header Parameters

Idempotency-Key?string

8–128 chars of letters, digits, _, -, : or .; scoped to your organization, key and path for 24 hours

Length8 <= length <= 128

Request Body

application/json
  1. body
url*string

Public HTTPS endpoint that answers 2xx within 10 s

Formaturi
Lengthlength <= 2048
events*array<string>

Exact event types, resource.* wildcards or *

Items1 <= items <= 64
description?|
Lengthlength <= 500
is_active?boolean
Defaulttrue

Response Body

The webhook, including its signing secret (shown once)

application/json
  1. response
success*boolean
request_id*string
Formatuuid
data?
Example Request
curl -X POST 'https://api.flowverify.co/v1/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "events": [    "string"  ]}'
Example Response
{  "success": true,  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",  "data": {    "object": "webhook",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "url": "string",    "events": [      "string"    ],    "description": "string",    "is_active": true,    "api_version": "string",    "last_delivery_at": "2019-08-24T14:15:22Z",    "last_status": "string",    "consecutive_failures": 0,    "disabled_at": "2019-08-24T14:15:22Z",    "disabled_reason": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "secret": "string"  }}