> For the complete documentation index, see [llms.txt](https://developers.evertransit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.evertransit.com/rest-api/api-references/webhooks.md).

# Webhooks

## About the Webhooks API

The EverTransit Webhooks API allows you to create a new webhook and delete an existing one. To make your requests, you can use the endpoints and their methods listed below. 

#### Endpoints

* [Create a webhook](#create-a-webhook)
* [Delete a webhook](#delete-a-webhook)

### The Webhook object

```json
{
  "id": "5f886c22fe5dd800318f8092",
  "events": [
    "ride_created"
  ],
  "endpoint": "https://myexample.com/mywebhook",
  "description": "My first webhook",
  "status": "active",
  "secret": "mysecret"
}
```

#### **Attributes**

| Name        | Type    | Description                                                                                          |
| ----------- | ------- | ---------------------------------------------------------------------------------------------------- |
| id          | string  | A unique identifier for the webhook.                                                                 |
| events      | array   | A list of all the events that the webhook will subscribe to.                                         |
| endpoint    | string  | A URL endpoint that will be called after the webhook receives any of the events it is subscribed to. |
| description | string  | Brief description of the webhook functionality.                                                      |
| status      | boolean | The status of the webhook. For example, active or disabled.                                          |
| secret      | string  | A unique identifier used to identify webhook.                                                        |

### Create a webhook

{% openapi src="<https://endpoints.evertransit.com/v2beta/spec>" path="/webhooks" method="post" %}
<https://endpoints.evertransit.com/v2beta/spec>
{% endopenapi %}

[**API playground for creating a webhook**](https://openapi.evertransit.com/#/Webhooks/create-webhook)

### Delete a webhook

{% openapi src="<https://endpoints.evertransit.com/v2beta/spec>" path="/webhooks/{webhookId}" method="delete" %}
<https://endpoints.evertransit.com/v2beta/spec>
{% endopenapi %}

[**API playground for deleting a webhook**](https://openapi.evertransit.com/#/Webhooks/delete-webhook)