/api/v5/webhook_subscription/

post

https://percolate.com/api/v5/webhook_subscription/

Create a webhook subscription (Preview).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

enable_mutual_tls

boolean

Defaults to false

Whether to enable mutual TLS support for the subscription.

events

array of objects

required

length ≥ 1

Types of events Percolate will be sending out to target url

events*

object_type

string

enum

required

change_type

string

enum

required

Allowed:

headers

array of objects

Headers that are delivered along with the event to the target url

headers

name

string

required

The name of the webhook subscription

message_ttl

integer

Defaults to 0

Time to live (in seconds). Event messages that could not be delivered (e.g. because target URL could not be reached) and are older than this many seconds will be discarded. Defaults to 0 which means there will be no ttl enforced. The maximum allowed duration is 72 hrs (259200 seconds).

scopes

array of objects

required

length ≥ 1

Scopes whose events will be published to the target url

scopes*

extend_scopes

boolean

Defaults to false

Whether to iteratively add subscription on all of the scope's children. (Will always be set to false regardless of the value provided as the functionality is yet to be supported).

scope_id

string

required

A valid license ID ^license:\d+$.

target_url

uri

required

The target for the events

Responses

201A new webhook_subscription was created

400Bad request

401Unauthorized

403Invalid authorization or resource not found

405Method not allowed

409Conflict

429Rate limit. Response should contain a Retry-After header

`Retry-After` header