webhooks
public

Get Webhook Endpoint

Get a webhook endpoint by ID.

Scopes: webhooks:read webhooks:write

get/v1/webhooks/endpoints/{id}

Path parameters

idstring uuid4 required

The webhook endpoint ID.

The webhook endpoint ID.

Response

Successful Response

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

urlstring required

The URL where the webhook events will be sent.

namestring nullable

An optional name for the webhook endpoint to help organize and identify it.

format'raw' | 'discord' | 'slack' required
secretstring required

The secret used to sign the webhook events.

organization_idstring uuid4 required

The organization ID associated with the webhook endpoint.

eventsWebhookEventType[] required

The events that will trigger the webhook.

enabledboolean required

Whether the webhook endpoint is enabled and will receive events.

Example response

{
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "secret": "whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"
}

Changes

Changed in 1 of the 11 revisions of this API.4

    • added the new discount.created enum value to the events/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new discount.deleted enum value to the events/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new discount.updated enum value to the events/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.cycled enum value to the events/items/ response property for the response status 200

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog