GET /webhooks

A GET to the /webhooks endpoint allows your application to fetch an array of the webhooks your user is authorizated to create and fetch moves for. Requests made to this endpoint require an authorization header using your authentication token:

curl --request GET \
  --url https://api.hopdrive.com/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <your token>'

Request

GET /v1/webhooks

Response

200 /v1/webhooks

{
    "webhooks": [
        {
            "id": 13,
            "description": "Just cancel events",
            "event_types": [
                "move.cancel.failed"
                "move.cancel.partial"
                "move.cancel.pending"
                "move.cancel.succeeded"
            ],
            "status": "disabled",
            "target_url": "https://webhook.site/27d9d588-1d4b-4150-9f30-42bacd4b1e5f?subscriber=13",
            "version": "1.0.0",
            "rooftop": 59,
            "secret": "new secret2",
            "createdat": "2022-08-22T01:39:42.496274+00:00",
            "updatedat": "2022-08-22T01:39:42.496274+00:00"
        },
        {
            "id": 14,
            "description": "A test webhook to listen to pickup and delivery successful events.",
            "event_types": [
                "move.pickup.started",
                "move.pickup.successful"
            ],
            "status": "disabled",
            "target_url": "https://webhook.site/27d9d588-1d4b-4150-9f30-42bacd4b1e5f?subscriber=14",
            "version": "1.0.0",
            "rooftop": 59,
            "secret": "G@Cjk%s45@ohfU",
            "createdat": "2022-08-22T01:39:42.496274+00:00",
            "updatedat": "2022-08-22T01:39:42.496274+00:00"
        }
    ]
}