Create a connection webhook

Register an HTTPS endpoint to receive signed events for connections managed by the caller’s partner (HQ) account. The signing secret is returned ONCE in this response and never again. Store it securely.

POST /connections/v1/webhooks

Create a connection webhook

cURL

curl --request POST \
  --url https://api.zapier.com/connections/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "connection.expiry_scheduled",
  "callback_url": "https://example.com/webhooks/zapier"
}
'

import requests

url = "https://api.zapier.com/connections/v1/webhooks"

payload = {
    "event_type": "connection.expiry_scheduled",
    "callback_url": "https://example.com/webhooks/zapier"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_type: 'connection.expiry_scheduled',
    callback_url: 'https://example.com/webhooks/zapier'
  })
};

fetch('https://api.zapier.com/connections/v1/webhooks', 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.zapier.com/connections/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event_type' => 'connection.expiry_scheduled',
    'callback_url' => 'https://example.com/webhooks/zapier'
  ]),
  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.zapier.com/connections/v1/webhooks"

	payload := strings.NewReader("{\n  \"event_type\": \"connection.expiry_scheduled\",\n  \"callback_url\": \"https://example.com/webhooks/zapier\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.zapier.com/connections/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_type\": \"connection.expiry_scheduled\",\n  \"callback_url\": \"https://example.com/webhooks/zapier\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zapier.com/connections/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_type\": \"connection.expiry_scheduled\",\n  \"callback_url\": \"https://example.com/webhooks/zapier\"\n}"

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

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_type": "connection.expiry_scheduled",
  "callback_url": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Authorizations

Authorization · string · header · required

OAuth 2.0 authentication.

Body

application/json

Input serializer for POST /webhooks.

event_type · enum<string> · required

The event to subscribe to.

• connection.expiry_scheduled - Expiry Scheduled

Available options: connection.expiry_scheduled

callback_url · string<uri> · required

HTTPS URL that signed events are POSTed to.

Callbacks

POST

{$request.body#/callback_url}connectionEvent

Body

application/json

Outbound event payload POSTed to callback_url (documentation only).

type · enum<string> · required

The event type. Matches the event_type this webhook subscribed to.

• connection.expiry_scheduled - Expiry Scheduled

Available options: connection.expiry_scheduled

expires_at · string<date-time> · required

ISO 8601 timestamp when the connection is scheduled to expire.

data · object · required

Event-specific details.

Show child attributes

Response

200

Event acknowledged. Any 2xx status is accepted.

Response

201

application/json

Created. Includes the signing secret (shown once).

Output serializer for POST 201. Includes the signing secret (returned once only).

id · string<uuid> · required · read-only

Unique webhook identifier (UUID).

event_type · enum<string> · required

The event type this webhook is subscribed to.

• connection.expiry_scheduled - Expiry Scheduled

Available options: connection.expiry_scheduled

callback_url · string<uri> · required · read-only

HTTPS URL that signed events are POSTed to.

is_active · boolean · required · read-only

Whether the webhook is active. Inactive webhooks do not receive events.

created_at · string<date-time> · required · read-only

ISO 8601 timestamp when the webhook was created.

updated_at · string<date-time> · required · read-only

ISO 8601 timestamp when the webhook was last updated.

secret · string · required · read-only

Standard Webhooks signing secret (whsec_…). Shown once, at creation.