WebhooksPaths
Defined in: src/webhooks/types.gen.ts:2
Properties
Section titled “Properties”/v1/webhooks
Section titled “/v1/webhooks”/v1/webhooks:
object
Defined in: src/webhooks/types.gen.ts:3
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List Webhooks
Description
Section titled “Description”List the webhooks you have registered
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Register Webhook
Description
Section titled “Description”Register an endpoint to start receiving selected webhook events
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header
Section titled “post.parameters.header”header:
object
post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”Idempotency-Key:
string
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.event_types
Section titled “post.requestBody.content.application/json.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”A list of the webhook event types this subscription will listen to.
post.requestBody.content.application/json.group_id?
Section titled “post.requestBody.content.application/json.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any. This is only available for partners.
Example
Section titled “Example”wg_123post.requestBody.content.application/json.url
Section titled “post.requestBody.content.application/json.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookpost.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Success
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.event_types
Section titled “post.responses.200.content.application/json.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”List of event types that this webhook subscription listens to.
Example
Section titled “Example”["EXPENSE_PAYMENT_UPDATED"]post.responses.200.content.application/json.group_id?
Section titled “post.responses.200.content.application/json.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any.
Example
Section titled “Example”wg_123post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”ID of the webhook subscription.
Example
Section titled “Example”wsub_123post.responses.200.content.application/json.status
Section titled “post.responses.200.content.application/json.status”status:
"ACTIVE"|"INACTIVE"
post.responses.200.content.application/json.url
Section titled “post.responses.200.content.application/json.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookpost.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.500
Section titled “post.responses.500”500:
object
Description
Section titled “Description”Internal server error
post.responses.500.content?
Section titled “post.responses.500.content?”
optionalcontent?:undefined
post.responses.500.headers
Section titled “post.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/{id}
Section titled “/v1/webhooks/{id}”/v1/webhooks/{id}:
object
Defined in: src/webhooks/types.gen.ts:27
delete
Section titled “delete”delete:
object
Unregister Webhook
Description
Section titled “Description”Unregister a webhook if you want to stop receiving webhook events
delete.parameters
Section titled “delete.parameters”parameters:
object
delete.parameters.cookie?
Section titled “delete.parameters.cookie?”
optionalcookie?:undefined
delete.parameters.header?
Section titled “delete.parameters.header?”
optionalheader?:undefined
delete.parameters.path
Section titled “delete.parameters.path”path:
object
delete.parameters.path.id
Section titled “delete.parameters.path.id”id:
string
delete.parameters.query?
Section titled “delete.parameters.query?”
optionalquery?:undefined
delete.requestBody?
Section titled “delete.requestBody?”
optionalrequestBody?:undefined
delete.responses
Section titled “delete.responses”responses:
object
delete.responses.200
Section titled “delete.responses.200”200:
object
Description
Section titled “Description”Success
delete.responses.200.content?
Section titled “delete.responses.200.content?”
optionalcontent?:undefined
delete.responses.200.headers
Section titled “delete.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.400
Section titled “delete.responses.400”400:
object
Description
Section titled “Description”Bad request
delete.responses.400.content?
Section titled “delete.responses.400.content?”
optionalcontent?:undefined
delete.responses.400.headers
Section titled “delete.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.401
Section titled “delete.responses.401”401:
object
Description
Section titled “Description”Unauthorized
delete.responses.401.content?
Section titled “delete.responses.401.content?”
optionalcontent?:undefined
delete.responses.401.headers
Section titled “delete.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.403
Section titled “delete.responses.403”403:
object
Description
Section titled “Description”Forbidden
delete.responses.403.content?
Section titled “delete.responses.403.content?”
optionalcontent?:undefined
delete.responses.403.headers
Section titled “delete.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.500
Section titled “delete.responses.500”500:
object
Description
Section titled “Description”Internal server error
delete.responses.500.content?
Section titled “delete.responses.500.content?”
optionalcontent?:undefined
delete.responses.500.headers
Section titled “delete.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get:
object
Get Webhook
Description
Section titled “Description”Get details of a webhook
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.event_types
Section titled “get.responses.200.content.application/json.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”List of event types that this webhook subscription listens to.
Example
Section titled “Example”["EXPENSE_PAYMENT_UPDATED"]get.responses.200.content.application/json.group_id?
Section titled “get.responses.200.content.application/json.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any.
Example
Section titled “Example”wg_123get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”ID of the webhook subscription.
Example
Section titled “Example”wsub_123get.responses.200.content.application/json.status
Section titled “get.responses.200.content.application/json.status”status:
"ACTIVE"|"INACTIVE"
get.responses.200.content.application/json.url
Section titled “get.responses.200.content.application/json.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookget.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
put:
object
Update Webhook
Description
Section titled “Description”Update a webhook. You can update the endpoint url, event types that the endpoint receives, or temporarily deactivate the webhook.
put.parameters
Section titled “put.parameters”parameters:
object
put.parameters.cookie?
Section titled “put.parameters.cookie?”
optionalcookie?:undefined
put.parameters.header?
Section titled “put.parameters.header?”
optionalheader?:undefined
put.parameters.path
Section titled “put.parameters.path”path:
object
put.parameters.path.id
Section titled “put.parameters.path.id”id:
string
put.parameters.query?
Section titled “put.parameters.query?”
optionalquery?:undefined
put.requestBody
Section titled “put.requestBody”requestBody:
object
put.requestBody.content
Section titled “put.requestBody.content”content:
object
put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”application/json:
object
put.requestBody.content.application/json.event_types
Section titled “put.requestBody.content.application/json.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”A list of the webhook event types this subscription will listen to.
put.requestBody.content.application/json.group_id?
Section titled “put.requestBody.content.application/json.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any. This is only available for partners.
Example
Section titled “Example”wg_123put.requestBody.content.application/json.status
Section titled “put.requestBody.content.application/json.status”status:
"ACTIVE"|"INACTIVE"
put.requestBody.content.application/json.url
Section titled “put.requestBody.content.application/json.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookput.responses
Section titled “put.responses”responses:
object
put.responses.200
Section titled “put.responses.200”200:
object
Description
Section titled “Description”Success
put.responses.200.content
Section titled “put.responses.200.content”content:
object
put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”application/json:
object
put.responses.200.content.application/json.event_types
Section titled “put.responses.200.content.application/json.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”List of event types that this webhook subscription listens to.
Example
Section titled “Example”["EXPENSE_PAYMENT_UPDATED"]put.responses.200.content.application/json.group_id?
Section titled “put.responses.200.content.application/json.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any.
Example
Section titled “Example”wg_123put.responses.200.content.application/json.id
Section titled “put.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”ID of the webhook subscription.
Example
Section titled “Example”wsub_123put.responses.200.content.application/json.status
Section titled “put.responses.200.content.application/json.status”status:
"ACTIVE"|"INACTIVE"
put.responses.200.content.application/json.url
Section titled “put.responses.200.content.application/json.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookput.responses.200.headers
Section titled “put.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.400
Section titled “put.responses.400”400:
object
Description
Section titled “Description”Bad request
put.responses.400.content?
Section titled “put.responses.400.content?”
optionalcontent?:undefined
put.responses.400.headers
Section titled “put.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.401
Section titled “put.responses.401”401:
object
Description
Section titled “Description”Unauthorized
put.responses.401.content?
Section titled “put.responses.401.content?”
optionalcontent?:undefined
put.responses.401.headers
Section titled “put.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.403
Section titled “put.responses.403”403:
object
Description
Section titled “Description”Forbidden
put.responses.403.content?
Section titled “put.responses.403.content?”
optionalcontent?:undefined
put.responses.403.headers
Section titled “put.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.500
Section titled “put.responses.500”500:
object
Description
Section titled “Description”Internal server error
put.responses.500.content?
Section titled “put.responses.500.content?”
optionalcontent?:undefined
put.responses.500.headers
Section titled “put.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/groups
Section titled “/v1/webhooks/groups”/v1/webhooks/groups:
object
Defined in: src/webhooks/types.gen.ts:56
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List Webhook Groups
Description
Section titled “Description”Lists webhook groups.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
Description
Section titled “Description”Cursor for pagination.
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number
Description
Section titled “Description”Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create Webhook Group
Description
Section titled “Description”Creates a webhook group.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header
Section titled “post.parameters.header”header:
object
post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”Idempotency-Key:
string
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.name
Section titled “post.requestBody.content.application/json.name”name:
string
Description
Section titled “Description”The name for the webhook group.
Example
Section titled “Example”Some Webhook Grouppost.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Success
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”The ID of the webhook group.
Example
Section titled “Example”wg_123post.responses.200.content.application/json.name
Section titled “post.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”The name for the webhook group.
Example
Section titled “Example”Some Webhook Grouppost.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.500
Section titled “post.responses.500”500:
object
Description
Section titled “Description”Internal server error
post.responses.500.content?
Section titled “post.responses.500.content?”
optionalcontent?:undefined
post.responses.500.headers
Section titled “post.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/groups/{id}
Section titled “/v1/webhooks/groups/{id}”/v1/webhooks/groups/{id}:
object
Defined in: src/webhooks/types.gen.ts:80
delete
Section titled “delete”delete:
object
Delete Webhook Group
Description
Section titled “Description”Deletes a webhook group and all its members.
delete.parameters
Section titled “delete.parameters”parameters:
object
delete.parameters.cookie?
Section titled “delete.parameters.cookie?”
optionalcookie?:undefined
delete.parameters.header?
Section titled “delete.parameters.header?”
optionalheader?:undefined
delete.parameters.path
Section titled “delete.parameters.path”path:
object
delete.parameters.path.id
Section titled “delete.parameters.path.id”id:
string
Description
Section titled “Description”The ID of the webhook group to delete.
delete.parameters.query?
Section titled “delete.parameters.query?”
optionalquery?:undefined
delete.requestBody?
Section titled “delete.requestBody?”
optionalrequestBody?:undefined
delete.responses
Section titled “delete.responses”responses:
object
delete.responses.200
Section titled “delete.responses.200”200:
object
Description
Section titled “Description”Success
delete.responses.200.content?
Section titled “delete.responses.200.content?”
optionalcontent?:undefined
delete.responses.200.headers
Section titled “delete.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.400
Section titled “delete.responses.400”400:
object
Description
Section titled “Description”Bad request
delete.responses.400.content?
Section titled “delete.responses.400.content?”
optionalcontent?:undefined
delete.responses.400.headers
Section titled “delete.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.401
Section titled “delete.responses.401”401:
object
Description
Section titled “Description”Unauthorized
delete.responses.401.content?
Section titled “delete.responses.401.content?”
optionalcontent?:undefined
delete.responses.401.headers
Section titled “delete.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.403
Section titled “delete.responses.403”403:
object
Description
Section titled “Description”Forbidden
delete.responses.403.content?
Section titled “delete.responses.403.content?”
optionalcontent?:undefined
delete.responses.403.headers
Section titled “delete.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.500
Section titled “delete.responses.500”500:
object
Description
Section titled “Description”Internal server error
delete.responses.500.content?
Section titled “delete.responses.500.content?”
optionalcontent?:undefined
delete.responses.500.headers
Section titled “delete.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get:
object
Get Webhook Group
Description
Section titled “Description”Gets a webhook group.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
Description
Section titled “Description”The ID of the webhook group to retrieve.
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”The ID of the webhook group.
Example
Section titled “Example”wg_123get.responses.200.content.application/json.name
Section titled “get.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”The name for the webhook group.
Example
Section titled “Example”Some Webhook Groupget.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/groups/{id}/add_members
Section titled “/v1/webhooks/groups/{id}/add_members”/v1/webhooks/groups/{id}/add_members:
object
Defined in: src/webhooks/types.gen.ts:104
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Add Webhook Group Members
Description
Section titled “Description”Adds members to webhook groups.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
Description
Section titled “Description”The ID of the webhook group to add members to.
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.members
Section titled “post.requestBody.content.application/json.members”members:
object[]
Description
Section titled “Description”The list of webhook group members to add to the group.
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Success
post.responses.200.content?
Section titled “post.responses.200.content?”
optionalcontent?:undefined
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.500
Section titled “post.responses.500”500:
object
Description
Section titled “Description”Internal server error
post.responses.500.content?
Section titled “post.responses.500.content?”
optionalcontent?:undefined
post.responses.500.headers
Section titled “post.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/groups/{id}/members
Section titled “/v1/webhooks/groups/{id}/members”/v1/webhooks/groups/{id}/members:
object
Defined in: src/webhooks/types.gen.ts:124
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List Webhook Group Members
Description
Section titled “Description”Lists the members currently in the specified webhook group.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
Description
Section titled “Description”The ID of the webhook group to retrieve members for.
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
Description
Section titled “Description”Cursor for pagination.
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number
Description
Section titled “Description”Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/groups/{id}/remove_members
Section titled “/v1/webhooks/groups/{id}/remove_members”/v1/webhooks/groups/{id}/remove_members:
object
Defined in: src/webhooks/types.gen.ts:144
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Remove Webhook Group Members
Description
Section titled “Description”Removes members from webhook groups.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
Description
Section titled “Description”The ID of the webhook group to remove members from.
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.members
Section titled “post.requestBody.content.application/json.members”members:
object[]
Description
Section titled “Description”The list of webhook group members to remove from the group.
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Success
post.responses.200.content?
Section titled “post.responses.200.content?”
optionalcontent?:undefined
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.500
Section titled “post.responses.500”500:
object
Description
Section titled “Description”Internal server error
post.responses.500.content?
Section titled “post.responses.500.content?”
optionalcontent?:undefined
post.responses.500.headers
Section titled “post.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/webhooks/secrets
Section titled “/v1/webhooks/secrets”/v1/webhooks/secrets:
object
Defined in: src/webhooks/types.gen.ts:164
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List Webhook Secrets
Description
Section titled “Description”This endpoint returns a set of webhook signing secrets used to validate the webhook. Usually only one key will be returned in the response. After key rotation, this endpoint will return two keys: the new key, and the key that will be revoked soon. There will also be two signatures in the ‘Webhook-Signature’ request header. Your application should use all keys available to validate the webhook request. If validation passes for any of the keys returned, the webhook payload is valid.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object[]
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined