> For the complete documentation index, see [llms.txt](https://docs-integration.squake.earth/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-integration.squake.earth/use-cases/webhooks-api-reference.md).

# Webhooks API Reference

## Creating a Webhook

To create a new webhook, send a POST request to the webhook endpoint.

### Endpoint

```
POST /api/v2/webhooks
```

### Request Parameters

| Parameter      | Type   | Required | Description                                                                                                       |
| -------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `kind`         | string | Yes      | The type of webhook. Must be one of: `order`, `confirmation_document_available`, `certificate_document_available` |
| `endpoint_url` | string | Yes      | The URL where webhook events will be sent                                                                         |

### Headers

* Authentication is required (based on the controller inheriting from BaseController)

### Request

```bash
curl -X POST \\
  <https://api.squake.earth/v2/webhooks> \\
  -H 'Authorization: Bearer YOUR_API_TOKEN' \\
  -H 'Content-Type: application/json' \\
  -d '{
    "kind": "order",
    "endpoint_url": "<https://your-domain.com/webhook-receiver>"
  }'

```

### Response

### Success (201 Created)

```json
{
    "id": "webhook_id",
    "kind": "order",
    "endpoint_url": "<https://your-domain.com/webhook-receiver>",
    "signing_key": "webhook_signing_key",  // Only provided on creation
    "last_sent_at": null,
    "last_failed_at": null,
    "failed_attempts": 0
}

```

## Updating a Webhook

Update an existing webhook configuration.

### Endpoint

```
PUT /api/v2/webhooks/:id
```

### Request Parameters

| Parameter      | Type   | Required | Description                                                                                                       |
| -------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `kind`         | string | No       | The type of webhook. Must be one of: `order`, `confirmation_document_available`, `certificate_document_available` |
| `endpoint_url` | string | No       | The URL where webhook events will be sent                                                                         |

### Example Request

```bash
curl -X PUT \\
  <https://api.squake.earth/v2/webhooks/webhook_id> \\
  -H 'Authorization: Bearer YOUR_API_TOKEN' \\
  -H 'Content-Type: application/json' \\
  -d '{
    "endpoint_url": "<https://your-domain.com/new-webhook-receiver>"
  }'

```

### Response

### Success (200 OK)

```json

    "id": "webhook_id",
    "kind": "order",
    "endpoint_url": "<https://your-domain.com/new-webhook-receiver>"
}

```

### Not Found (404)

Returned when the webhook ID doesn't exist or belongs to another client.

## Deleting a Webhook

Remove an existing webhook configuration.

### Endpoint

```
DELETE /api/v2/webhooks/:id
```

### Example Request

```bash
curl -X DELETE \\
  <https://api.squake.earth/v2/webhooks/webhook_id> \\
  -H 'Authorization: Bearer YOUR_API_TOKEN'

```

### Important Notes

1. The webhook signing key is only returned once during webhook creation. Make sure to store it securely.
2. The endpoint URL must be a valid HTTPS URL that can receive POST requests.
3. Each client can create multiple webhooks for different purposes.
4. Available webhook kinds:
   * `order`: Notifications about order-related even
   * `confirmation_document_available`: Notifications when confirmation documents become available
   * `certificate_document_available`: Notifications when certificate documents become available


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs-integration.squake.earth/use-cases/webhooks-api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.