Pipedrive Oauth API
Getting access, Developing, Testing
Back to Pipedrive OauthGet all Webhooks
Returns data about all the Webhooks of a company.
Output
title: getWebhooksResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
status:
type: string
description: The status of the response
data:
type: array
description: The array of Webhooks
items:
type: object
properties:
id:
type: integer
description: The ID of the Webhook
company_id:
type: integer
description: The ID of the company related to the Webhook
owner_id:
type: integer
description: The ID of the user who owns the Webhook
user_id:
type: integer
description: The ID of the user related to the Webhook
event_action:
type: string
description: The Webhook action
event_object:
type: string
description: The Webhook object
subscription_url:
type: string
description: The subscription URL of the Webhook
is_active:
description: The Webhook's status
title: numberBooleanDefault1
type: number
default: 1
enum:
- 0
- 1
add_time:
type: string
format: date-time
description: The date when the Webhook was added
remove_time:
type: string
format: date-time
nullable: true
description: The date when the Webhook was removed (if removed)
type:
type: string
enum:
- general
- app
description: The type of the Webhook
http_auth_user:
type: string
nullable: true
description: The username of the `subscription_url` of the Webhook
http_auth_password:
type: string
nullable: true
description: The password of the `subscription_url` of the Webhook
additional_data:
type: object
description: Any additional data related to the Webhook
remove_reason:
type: string
nullable: true
description: The removal reason of the Webhook (if removed)
last_delivery_time:
type: string
format: date-time
nullable: true
description: The last delivery time of the Webhook
last_http_status:
type: integer
nullable: true
description: The last delivery HTTP status of the Webhook
admin_id:
type: integer
description: The ID of the admin of the Webhook