Put v1webhooks

Update an existing webhook by ID. Only provided fields will be updated.

PUT /v1/webhooks/{id}

cURL

cURL

curl --request PUT \
  --url https://api.transmit.dev/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "nickname": "<string>",
  "subscribed_events": [
    "<string>"
  ]
}
'

import requests

url = "https://api.transmit.dev/v1/webhooks/{id}"

payload = {
    "url": "<string>",
    "nickname": "<string>",
    "subscribed_events": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', nickname: '<string>', subscribed_events: ['<string>']})
};

fetch('https://api.transmit.dev/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.transmit.dev/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'nickname' => '<string>',
    'subscribed_events' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.transmit.dev/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"subscribed_events\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.transmit.dev/v1/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"subscribed_events\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.transmit.dev/v1/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"subscribed_events\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "url": "<string>",
  "subscribed_events": [
    "<string>"
  ],
  "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
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Body

application/json

url · string<uri>

nickname · string

subscribed_events · string[]

Minimum array length: 1

status · enum<string>

Available options: active, inactive

Response

200

application/json

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