Skip to main content
POST
/
v1
/
webhooks
cURL
curl --request POST \
  --url https://api.transmit.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "nickname": "<string>",
  "subscribed_events": [
    "<string>"
  ],
  "status": "active"
}'
{
  "id": "<string>",
  "url": "<string>",
  "nickname": "<string>",
  "subscribed_events": [
    "<string>"
  ],
  "status": "active",
  "secret": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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.

Body

application/json
url
string<uri>
required
subscribed_events
string[]
required
Minimum length: 1
nickname
string
status
enum<string>
Available options:
active,
inactive

Response

Webhook created 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

updated_at
string<date-time>
required

Last update timestamp

nickname
string

Webhook nickname

secret
string

Webhook secret (only returned on creation)

last_delivery_at
string<date-time> | null

Last delivery timestamp

failure_count
number

Failed delivery count

success_count
number

Successful delivery count

total_delivery_count
number

Total delivery attempts

⌘I