Get a Webhook

Get all integration account webhooks for a given workspace.

HTTP Request

GET https://dev.calry.app/api/v1/integration_account_webhook

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Query Parameters

Parameter	Required	Type	Description
integrationAccountId	Yes	string	Unique identifier for Integration Account.

Response

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

• integrationAccountWebhookId (string): A unique identifier for the Integration Account Webhook.
• name (string): Name of 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.
• receiverUrl (string): URL to receive the webhook.
• listenerUrl (array): URL to listen to the webhook.
• integrationAccountId (string): Unique identifier for Integration Account.
• integrationDefinitionId (string): Unique identifier for the Integration Definition.
• workspaceId (string): Unique identifier for Workspace.
• apiSupport (boolean): Indicates if the webhook supports API.
• createdAt (string): When the Integration Account Webhook was created.
• updatedAt (string): When the Integration Account Webhook was updated last.
• deleted (string|null): Indicates if the Integration Account Webhook 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/integration_account_webhook?integrationAccountId=6eabebf8-d74c-4175-ae60-df798e62aeec' \
--header 'Authorization: Bearer eyJraWQiOiJzLWM1MzhlMzZiLWJlZDktNDUyZi04MDY3LTc3ZWY5ODQ5MjZiYyIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjQxY2E4YjA4LTU1OWMtNGZkNS1iODVlLTI3Y2NiYmE1ZDI1OSIsIndvcmtzcGFjZUlkIjoiMjdhYzk5ZjMtZGNlMi00MWVlLWEyYzAtNWQ4YzlkZGM0NGEyIiwibmFtZSI6InNhZGZzIiwic291cmNlIjoibWljcm9zZXJ2aWNlIiwiaWF0IjoxNzEwMDg3NDI1LCJleHAiOjE3MzMzMTk3NDh9.T4O8HaXsKOjmSYj7rQ8_FwBH-mDTrsSqn6cqyIIdD8xcnQq3ukuXgUDFXI8wk5uLTSAhmEs2ccA29I2bVHK9Y1iV-65ouq_2aOQMRjIiAPyN2z5Z98cp7Wz7rLWIonGlQo0mVq7CEQ8DcBZnHYGqXtnBGRsu4okOJwzwV2Zkuj2bxp-yI9VcVT1Vt7wAxxOQ-m4YxC7LJDNw5SOG4ajLPwzsjZYubeFQCodLInn6v_ZGu9SmMaORixeOulMXHzKDcazGGvMbgqq5OQkK-MRO1u5GOg74WoOSpPhJXigcd3fGB_OdM7SBKc6mBnLTgRoLtYOOYy5y3b2Pa8oJXw6XWA'

Example Response

[
    {
        "integrationAccountWebhookId": "dd543113-d904-4ea5-9d3c-97cad062826a",
        "name": "test-hostaway",
        "enabled": true,
        "headers": null,
        "ipAddress": "127.0.0.1",
        "eventSubscription": {
            "reservation.created": true,
            "reservation.deleted": false,
            "reservation.updated": true,
            "conversation.updated": true
        },
        "receiverUrl": "https://webhook.site/2f1b2df0-5aac-42c1-ab79-43760776bde4",
        "listenerUrl": [
            "https://fedb-2406-7400-51-c697-8dad-8b9b-3fba-cfcf.ngrok-free.app/api/v1/listener/hostaway/6eabebf8-d74c-4175-ae60-df798e62aeec"
        ],
        "integrationAccountId": "6eabebf8-d74c-4175-ae60-df798e62aeec",
        "integrationDefinitionId": "1ea16ec2-c3ac-4ab9-a8d3-4f67063ce03c",
        "workspaceId": "27ac99f3-dce2-41ee-a2c0-5d8c9ddc44a2",
        "apiSupport": true,
        "createdAt": "2024-03-10T16:19:23.988Z",
        "updatedAt": "2024-03-10T16:19:23.988Z",
        "deleted": null
    }
]