Retrieve Webhook Information

GET /v2/webhooks/{id}

Bearer auth

This endpoint allows you to retrieve an information about a specific Webhook

Path parameters

id string Required

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id string(uuid)
  
  A unique identifier for the webhook, represented as a universally unique identifier (UUID)
- last_failed_at string | null
  
  The timestamp of the most recent failed delivery attempt. If no failures have occurred, this field is null
- last_sent_at string | null
  
  he timestamp of the most recent successful delivery attempt. If no attempts have been made, this field is null
- failed_attempts integer
  
  The total number of consecutive failed delivery attempts
- kind string
  
  The type of event that triggers the webhook
  
  Values are order, carbon_activity_expired, confirmation_document_available, or certificate_document_available.
- endpoint_url string(uri)
  
  The URL where the webhook payloads are sent. Must be a valid URI that accepts POST requests
404

Not Found

GET /v2/webhooks/{id}

curl \
 -X GET https://api.squake.earth/v2/webhooks/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "order",
  "signing_key": "TAWHPBAVckH8KmxRtlRX/rQ/mona5vUem7QFtozGHxM=",
  "endpoint_url": "http://example.com",
  "last_sent_at": "2024-08-24T14:15:22Z",
  "last_failed_at": "2024-08-22T14:10:78Z",
  "failed_attempts": 0
}