Skip to main content
GET
/
v1
/
webhooks
/
{id}
cURL
curl --request GET \
  --url https://api.transmit.dev/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "url": "<string>",
  "subscribed_events": [
    "<string>"
  ],
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "nickname": "<string>",
  "secret": "<string>",
  "last_delivery_at": "2023-11-07T05:31:56Z",
  "failure_count": 123,
  "success_count": 123,
  "total_delivery_count": 123
}

Authorizations

ā€‹
Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Path Parameters

ā€‹
id
string
required

Response

Webhook retrieved successfully

ā€‹
id
string
required

Webhook ID

ā€‹
url
string<uri>
required

Webhook URL

ā€‹
subscribed_events
string[]
required

Subscribed event types

ā€‹
status
enum<string>
required

Webhook status

Available options:
active,
inactive
ā€‹
created_at
string<date-time>
required

Creation timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
updated_at
string<date-time>
required

Last update timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
nickname
string

Webhook nickname

ā€‹
secret
string

Webhook secret (only returned on creation)

ā€‹
last_delivery_at
string<date-time> | null

Last delivery timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
failure_count
number

Failed delivery count

ā€‹
success_count
number

Successful delivery count

ā€‹
total_delivery_count
number

Total delivery attempts