Skip to content
Pidgely Docs

API reference · Webhooks

Update a webhook

PATCHhttps://api.pidgely.com/webhooks/{id}
View as Markdown

Changes the endpoint URL, the subscribed events or the status. A disabled webhook receives nothing, and deliveries already queued for it are dropped.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Resource id UUID.

Body parameters

JSON object.

Name Type Required Description
endpoint string No Public https URL that receives the events.
events string[] No Event types to subscribe to, for example email.delivered. See Webhooks.
status string No Current status. One of enabled, disabled.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.webhooks.update('0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73', {
  events: [
    'email.delivered',
    'email.bounced',
    'email.complained',
    'email.delivery_delayed',
  ],
  status: 'enabled',
});
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Webhooks.update("0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73", {
    "events": [
        "email.delivered",
        "email.bounced",
        "email.complained",
        "email.delivery_delayed",
    ],
    "status": "enabled",
})
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->webhooks->update('0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73', [
    'events' => [
        'email.delivered',
        'email.bounced',
        'email.complained',
        'email.delivery_delayed',
    ],
    'status' => 'enabled',
]);
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Webhooks.Update(ctx, "0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73", &pidgely.UpdateWebhookRequest{
		Events: []string{"email.delivered", "email.bounced", "email.complained", "email.delivery_delayed"},
		Status: "enabled",
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Webhooks.update("0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73", {
  events: [
    "email.delivered",
    "email.bounced",
    "email.complained",
    "email.delivery_delayed"
  ],
  status: "enabled"
})
puts result
cURL
curl -X PATCH 'https://api.pidgely.com/webhooks/0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "events": [
    "email.delivered",
    "email.bounced",
    "email.complained",
    "email.delivery_delayed"
  ],
  "status": "enabled"
}'

Response

200 OK

JSON
{
  "object": "webhook",
  "id": "0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73"
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.