Delete a webhook relay configuration
Removes the stored webhook relay settings for the specified type from the authenticated user account.
OpenAPI
````yaml delete /api/v2/webhookRelay/{type}
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/webhookRelay/{type}:
delete:
tags:
- Webhooks
summary: Delete a webhook relay configuration
description: >-
Removes the stored webhook relay settings for the specified type from
the authenticated user account.
parameters:
- name: type
in: path
required: true
schema:
type: string
description: Relay type to delete (must be one previously configured)
example: twilioSMS
responses:
'200':
description: Relay configuration deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Webhook Relay type 'twilioSMS' removed successfully.
'400':
description: Missing or invalid type parameter
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: type path parameter is required and must be a string
'401':
description: Unauthorized – missing or invalid API key/token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Unauthorized Request
'403':
description: Forbidden – feature requires GetVoiceBot Premium
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: >-
Webhook Relay is a premium feature. Please upgrade your
account to use it.
'404':
description: Relay type was not configured for this user
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Webhook Relay type 'foo' was not configured.
'500':
description: Server error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Internal error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
