Skip to content

Get webhook details

GET
/webhook/{webhookId}

Retrieves details of a specific webhook

Authorizations

Parameters

Path Parameters

webhookId
required
string format: uuid

The unique identifier of the webhook

Responses

200

Successfully retrieved webhook details

object
webhookId

The unique id for the webhook

string format: uuid
name

The name of the webhook

string
description

The description of the webhook

string
url
required

The url of the webhook

string format: uri
enabledEvents
required

A list of event names that this webhook is configured to listen to

Array<string>
signingSecret

The secret used to sign the webhook payload

string
status

The status of the webhook

string
Allowed values: active paused disabled
lastTriggeredAt

The date and time the webhook was last triggered

string format: date-time
createdAt

The date and time the webhook was created

string format: date-time

401

Unauthorized

object
code
required

HTTP status code

integer
status
required

Error status message

string

404

Not Found

object
code
required

HTTP status code

integer
status
required

Error status message

string

500

Internal Server Error

object
code
required

HTTP status code

integer
status
required

Error status message

string