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
The Webhook object
{
"id": "5f886c22fe5dd800318f8092",
"events": [
"ride_created"
],
"endpoint": "https://myexample.com/mywebhook",
"description": "My first webhook",
"status": "active",
"secret": "mysecret"
}
Attributes
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 new webhook.
A list of all the events that the webhook will subscribe to.
ride_created
A URL endpoint that will be called after the webhook receives any of the events it is subscribed to.
https://myexample.com/mywebhook
A unique identifier used to identify your webhook.
my-secret
Brief description of the webhook functionality.
My first webhook
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.
A unique identifier for the webhook.
ivan1qdJKrlURIBx7Rsj
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"
}
Last updated
Was this helpful?