# Create a webhook

> Registers an HTTPS endpoint for one or more events. Deliveries are signed with the Standard Webhooks scheme (webhook- and svix- headers). The response includes the signing_secret (whsec_…) used to…

Source: https://docs.pidgely.com/api-reference/webhooks/create/

`POST https://api.pidgely.com/webhooks`

Registers an HTTPS endpoint for one or more events. Deliveries are signed with the Standard Webhooks scheme (`webhook-*` and `svix-*` headers). The response includes the `signing_secret` (`whsec_…`) used to [verify signatures](https://docs.pidgely.com/guides/webhooks/#verify-signatures). The endpoint must be a public `https` URL.

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

## Body parameters

JSON object.

| Name | Type | Required | Description |
|---|---|---|---|
| `endpoint` | string | Yes | Public `https` URL that receives the events. |
| `events` | string[] | Yes | Event types to subscribe to, for example `email.delivered`. See [Webhooks](https://docs.pidgely.com/guides/webhooks/#events). |

## Request

```js tab="Node.js"
import { Pidgely } from 'pidgely';

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

const { data, error } = await pidgely.webhooks.create({
  endpoint: 'https://acme.com/webhooks/pidgely',
  events: ['email.delivered', 'email.bounced', 'email.complained'],
});
console.log(data ?? error);
```

```python tab="Python"
import os
import pidgely

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

result = pidgely.Webhooks.create({
    "endpoint": "https://acme.com/webhooks/pidgely",
    "events": ["email.delivered", "email.bounced", "email.complained"],
})
print(result)
```

```php tab="PHP"
<?php

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

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

$result = $pidgely->webhooks->create([
    'endpoint' => 'https://acme.com/webhooks/pidgely',
    'events' => ['email.delivered', 'email.bounced', 'email.complained'],
]);
var_dump($result);
```

```go tab="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.Create(ctx, &pidgely.CreateWebhookRequest{
		Endpoint: "https://acme.com/webhooks/pidgely",
		Events:   []string{"email.delivered", "email.bounced", "email.complained"},
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
```

```ruby tab="Ruby"
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Webhooks.create({
  endpoint: "https://acme.com/webhooks/pidgely",
  events: ["email.delivered", "email.bounced", "email.complained"]
})
puts result
```

```bash tab="cURL"
curl -X POST 'https://api.pidgely.com/webhooks' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": "https://acme.com/webhooks/pidgely",
  "events": [
    "email.delivered",
    "email.bounced",
    "email.complained"
  ]
}'
```

## Response

`200 OK`

```json
{
  "object": "webhook",
  "id": "0199d7f2-8b1d-7c3a-a2e5-4f9c6d0b1e73",
  "signing_secret": "whsec_9rXbB2n3cKqL1sT8vW4yZ6aD0fG5hJ7k"
}
```

### Response fields

| Name | Type | Required | Description |
|---|---|---|---|
| `object` | string | No | Object type. |
| `id` | string | No | Unique id (UUID). UUID. |
| `signing_secret` | string | No | Secret (`whsec_…`) used to verify webhook signatures. |

## Errors

Errors have the shape `{"statusCode", "name", "message"}`. See [Errors](https://docs.pidgely.com/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. |