Skip to main content

Delete Webhook

Delete an existing integration account webhook for a given integration account.

HTTP Request​

DELETE https://dev.calry.app/api/v1/integration_account_webhook/{integrationAccountWebhookId}

Headers​

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN

Path Parameters​

ParameterRequiredTypeDescription
integrationAccountWebhookIdYesstringUnique identifier for the Integration Account Webhook.

Example cURL Request​

curl --location --request DELETE 'https://dev.calry.app/api/v1/integration_account_webhook/c0f70f65-643e-4591-ad49-f6c04643c40b' \
--header 'Authorization: Bearer eyJraWQiOiJzLWM1MzhlMzZiLWJlZDktNDUyZi04MDY3LTc3ZWY5ODQ5MjZiYyIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjQxY2E4YjA4LTU1OWMtNGZkNS1iODVlLTI3Y2NiYmE1ZDI1OSIsIndvcmtzcGFjZUlkIjoiMjdhYzk5ZjMtZGNlMi00MWVlLWEyYzAtNWQ4YzlkZGM0NGEyIiwibmFtZSI6InF3ZXdld2UiLCJzb3VyY2UiOiJtaWNyb3NlcnZpY2UiLCJpYXQiOjE3MTAwOTA1MDgsImV4cCI6MjkyMjIxMTcyMH0.QKBiXrdWXWFsvWxlRqj-HLRleIfy5114tgGoz1g4hZRG_5idxRh7wJYq0QdNbZfE1e62SfWJhOGZbr5TydZl81LhFT7d7ABKPeHphtcY-Gpc1eDNCkwHRHjqHoVd2ipscPMTATIxKHCXUBya4BIE6zMaz9Z0pNoUNfVBZKJ96qGDH0fMNMFRJ-QZs1Esnt5br_vT4dkADn1BFa4eGfq_Y-DN0B9PONS1GuonADKksMo4jj572vU3rvtZMcq1BCzjJkQ86os-fsBNffqCoSWS2Y9MX3iBanltk790ZGdByBRPLcTt2s4HXoRGUhiUFcW2eJucsYDLRwA3T_q325DptA'

Response​

The response is a 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 deleted the Integration Account Webhook.
  • 400 Bad Request: The request was invalid or missing parameters.
  • 401 Unauthorized: The request lacks valid authentication credentials.
  • 404 Not Found: The requested resource could not be found.

Example Response​

{
    "integrationAccountWebhookId": "c0f70f65-643e-4591-ad49-f6c04643c40b",
    "name": "Hostway Account11",
    "enabled": true,
    "headers": null,
    "ipAddress": "127.0.0.1",
    "eventSubscription": {
        "reservation.created": true,
        "reservation.deleted": false,
        "reservation.updated": true,
        "conversation.updated": false
    },
    "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:34:42.279Z",
    "updatedAt": "2024-03-10T16:34:42.279Z",
    "deleted": null
}