Skip to main content

Get a Webhook of Workspace

Get a webhook for a given workspace.

HTTP Request​

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

Headers​

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN

Query Parameters​

ParameterRequiredTypeDescription
workspaceIdYesstringUnique identifier for Workspace.

Response​

The response is a JSON object containing the following properties:

  • webhookId (string): A unique identifier for the Webhook.
  • name (string): Name of the webhook.
  • secret (string): Secret for the webhook.
  • enabled (boolean): Indicates if the webhook is enabled.
  • ipAddress (string): IP address of the webhook.
  • workspaceId (string): Unique identifier for Workspace.
  • createdAt (string): When the Webhook was created.
  • updatedAt (string): When the Webhook was updated last.
  • deleted (string|null): Indicates if the 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/webhook?workspaceId=27ac99f3-dce2-41ee-a2c0-5d8c9ddc44a2' \
--header 'Authorization: Bearer eyJraWQiOiJzLWM1MzhlMzZiLWJlZDktNDUyZi04MDY3LTc3ZWY5ODQ5MjZiYyIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjQxY2E4YjA4LTU1OWMtNGZkNS1iODVlLTI3Y2NiYmE1ZDI1OSIsIndvcmtzcGFjZUlkIjoiMjdhYzk5ZjMtZGNlMi00MWVlLWEyYzAtNWQ4YzlkZGM0NGEyIiwibmFtZSI6InNhZGZzIiwic291cmNlIjoibWljcm9zZXJ2aWNlIiwiaWF0IjoxNzEwMDg3NDI1LCJleHAiOjE3MzMzMTk3NDh9.T4O8HaXsKOjmSYj7rQ8_FwBH-mDTrsSqn6cqyIIdD8xcnQq3ukuXgUDFXI8wk5uLTSAhmEs2ccA29I2bVHK9Y1iV-65ouq_2aOQMRjIiAPyN2z5Z98cp7Wz7rLWIonGlQo0mVq7CEQ8DcBZnHYGqXtnBGRsu4okOJwzwV2Zkuj2bxp-yI9VcVT1Vt7wAxxOQ-m4YxC7LJDNw5SOG4ajLPwzsjZYubeFQCodLInn6v_ZGu9SmMaORixeOulMXHzKDcazGGvMbgqq5OQkK-MRO1u5GOg74WoOSpPhJXigcd3fGB_OdM7SBKc6mBnLTgRoLtYOOYy5y3b2Pa8oJXw6XWA'

Example Response​

{
    "webhookId": "5379c453-4066-40cb-b09e-856e230ef32e",
    "name": "fierce-orange",
    "secret": "87895007-6e3a-43a3-aba8-4d63a20ebf05",
    "enabled": true,
    "ipAddress": "127.0.0.1",
    "workspaceId": "27ac99f3-dce2-41ee-a2c0-5d8c9ddc44a2",
    "createdAt": "2024-03-10T17:42:21.834Z",
    "updatedAt": "2024-03-10T17:42:21.834Z",
    "deleted": null
}