Skip to main content

Get All Webhook Endpoints

Get all webhook endpoints for a given the workspace.

HTTP Request​

GET https://dev.calry.app/api/v1/webhook/{webhookId}/endpoints

Headers​

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN

Query Parameters​

ParameterRequiredTypeDescription
webhookIdYesstringUnique identifier for Webhook.

Response​

The response is a array of JSON object containing the following properties:

  • webhookEndpointId (string): A unique identifier for the Webhook Endpoint.
  • name (string): Name of the webhook.
  • url (string): URL to receive the webhook.
  • enabled (boolean): Indicates if the webhook is enabled.
  • headers (object): Headers for the webhook.
  • ipAddress (string): IP address of the webhook.
  • eventSubscription (object): Event subscription for the webhook.
  • webhookId (string): Unique identifier for Webhook.
  • createdAt (string): When the Webhook Endpoint was created.
  • updatedAt (string): When the Webhook Endpoint was updated last.
  • deleted (string|null): Indicates if the Webhook Endpoint has been deleted.

Response Codes​

  • 200 OK: Successfully retrieved the link details.
  • 400 Bad Request: The request was invalid or missing parameters.
  • 401 Unauthorized: The request lacks valid authentication credentials.

Example cURL Request​

curl --location 'https://dev.calry.app/api/v1/webhook/5379c453-4066-40cb-b09e-856e230ef32e/endpoints' \
--header 'Authorization: Bearer eyJraWQiOiJzLWM1MzhlMzZiLWJlZDktNDUyZi04MDY3LTc3ZWY5ODQ5MjZiYyIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjQxY2E4YjA4LTU1OWMtNGZkNS1iODVlLTI3Y2NiYmE1ZDI1OSIsIndvcmtzcGFjZUlkIjoiMjdhYzk5ZjMtZGNlMi00MWVlLWEyYzAtNWQ4YzlkZGM0NGEyIiwibmFtZSI6InNhZGZzIiwic291cmNlIjoibWljcm9zZXJ2aWNlIiwiaWF0IjoxNzEwMDg3NDI1LCJleHAiOjE3MzMzMTk3NDh9.T4O8HaXsKOjmSYj7rQ8_FwBH-mDTrsSqn6cqyIIdD8xcnQq3ukuXgUDFXI8wk5uLTSAhmEs2ccA29I2bVHK9Y1iV-65ouq_2aOQMRjIiAPyN2z5Z98cp7Wz7rLWIonGlQo0mVq7CEQ8DcBZnHYGqXtnBGRsu4okOJwzwV2Zkuj2bxp-yI9VcVT1Vt7wAxxOQ-m4YxC7LJDNw5SOG4ajLPwzsjZYubeFQCodLInn6v_ZGu9SmMaORixeOulMXHzKDcazGGvMbgqq5OQkK-MRO1u5GOg74WoOSpPhJXigcd3fGB_OdM7SBKc6mBnLTgRoLtYOOYy5y3b2Pa8oJXw6XWA'

Example Response​

[
    {
        "webhookEndpointId": "3df3b6fa-5b85-4dd4-bbed-c20ce1429a3c",
        "name": "test",
        "url": "https://webhook.site/2f1b2df0-5aac-42c1-ab79-43760776bde4",
        "enabled": true,
        "headers": {},
        "ipAddress": "127.0.0.1",
        "eventSubscription": {
            "sync.error": false,
            "sync.paused": true,
            "link.created": true,
            "link.deleted": true,
            "link.updated": false,
            "sync.complete": false,
            "account.created": false,
            "account.deleted": false,
            "account.updated": false,
            "property.created": false,
            "property.deleted": false,
            "property.updated": true,
            "properties.synced": false,
            "reservation.created": false,
            "reservation.deleted": false,
            "reservation.updated": true,
            "reservations.synced": false,
            "conversation.created": false,
            "conversation.deleted": false,
            "conversation.updated": false,
            "conversations.synced": false
        },
        "webhookId": "5379c453-4066-40cb-b09e-856e230ef32e",
        "createdAt": "2024-03-10T17:49:17.057Z",
        "updatedAt": "2024-03-10T17:49:17.057Z",
        "deleted": null
    }
]