Skip to content

place.stream.server.deleteWebhook

Lexicon Version: 1

Type: procedure

Delete an existing webhook.

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
idstringThe ID of the webhook to delete.

Output:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
successbooleanWhether the webhook was successfully deleted.

Possible Errors:

  • WebhookNotFound: The specified webhook was not found.
  • Unauthorized: The authenticated user does not have access to this webhook.

{
"lexicon": 1,
"id": "place.stream.server.deleteWebhook",
"defs": {
"main": {
"type": "procedure",
"description": "Delete an existing webhook.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "The ID of the webhook to delete."
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["success"],
"properties": {
"success": {
"type": "boolean",
"description": "Whether the webhook was successfully deleted."
}
}
}
},
"errors": [
{
"name": "WebhookNotFound",
"description": "The specified webhook was not found."
},
{
"name": "Unauthorized",
"description": "The authenticated user does not have access to this webhook."
}
]
}
}
}