Webhook Endpoints

A Webhook Endpoint is an object in Modern Treasury that describes an endpoint where your webhook will send data to over HTTPS.

Attribute

Description

id
string

Unique Identifier for Webhook Endpoints.

live_mode
boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

url
string

A HTTPS endpoint that will receive notifications from webhooks.

configured_events
object

This field describes which events the webhook endpoint is subscribed towards. By default, if no events are provided, it subscribes to all events. An optional array of event types, which can be found here.

webhook_key
string

The secret key used to sign the webhook body. See Verifying Webhooks. Only shown when created, so make sure to save it!

enabled
boolean

This field describes whether or not this webhook endpoint is paused/enabled.

discarded_at
datetime

This field describe when this object was deleted.

created_at
datetime

This field describes when this object was created.

updated_at
datetime

This field describes when this object was last updated.

{
  "id": "5bcbec62-69df-46dd-9849-e89f42f9dc31",
  "object": "webhook_endpoint",
  "live_mode": false,
  "url": "https://<your-domain.com>",
  "configured_events": {},
  "webhook_key": "<webhook key>",
  "enabled": true,
  "discarded_at": null,
  "created_at": "2022-02-16T02:09:08Z",
  "updated_at": "2022-02-16T02:09:08Z"
}