Create a WebhookEndpoint

post

https://api.prtmb.com/api/v2/accounts/{account_id}/webhook-endpoints

Create a WebhookEndpoint resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

required

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

Body Params

Success

Create an WebhookEndpoint

description

string

An optional description.

enabled_events

array of strings

A list of events to enable for this endpoint. ["*"] indicates that all events are
enabled, except any that require explicit selection.

enabled_events

metadata

object

A set of key-value pairs you can attach to the endpoint. This can be useful for
storing additional information about the endpoint in a structured format.

status

string

enum

The status of the webhook. It can be enabled or disabled.

Allowed:

url

string

The URL of the webhook endpoint.

Response

Callback

200Success