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

• Delete a webhook

The Webhook object

{
  "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

Create a webhook.

post

Create a new webhook.

Authorizations

ApiKeyAuth

apikeystringRequired

Body

application/json

eventsstring[]Required

A list of all the events that the webhook will subscribe to.

Example: ride.created

endpointstring · uriRequired

A URL endpoint that will be called after the webhook receives any of the events it is subscribed to.

Example: https://myexample.com/mywebhook

secretstringOptional

A unique identifier used to identify your webhook.

Example: my-secret

descriptionstringOptional

Brief description of the webhook functionality.

Example: My first webhook

Responses

200

The webhook was created successfully.

application/json

400

Bad request.

application/json

401

Unauthorized.

application/json

post

/webhooks

HTTPcURLJavaScriptPython

POST /v2beta/webhooks HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "events": [
    "ride.created"
  ],
  "endpoint": "https://myexample.com/mywebhook",
  "secret": "my-secret",
  "description": "My first webhook"
}

{
  "id": "text",
  "events": [
    "text"
  ],
  "endpoint": "https://myexample.com/mywebhook",
  "description": "My first webhook",
  "status": "active",
  "secret": "my-secret"
}

API playground for creating a webhook

Delete a webhook

Delete a webhook.

delete

Delete a webhook.

Authorizations

ApiKeyAuth

apikeystringRequired

Path parameters

webhookIdstringRequired

A unique identifier for the webhook.

Example: ivan1qdJKrlURIBx7Rsj

Responses

200

The webhook was deleted successfully.

application/json

401

Unauthorized.

application/json

404

Not found.

application/json

delete

/webhooks/{webhookId}

HTTPcURLJavaScriptPython

DELETE /v2beta/webhooks/{webhookId} HTTP/1.1
Host: endpoints.evertransit.com
Accept: */*

{
  "id": "text",
  "events": [
    "text"
  ],
  "endpoint": "https://myexample.com/mywebhook",
  "description": "My first webhook",
  "status": "active",
  "secret": "my-secret"
}

API playground for deleting a webhook