External events

Update Webhook Configuration

put

Updates an existing webhook configuration

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
configurationIdnumberRequiredPattern: [^\/#\?]+?
Body
idnumberRequired

Id of the webhook configuration

Example: 1
namestringRequired

Name of the webhook configuration

Example: Webhook for Order Events
attributesobjectOptional

Attributes of the webhook configuration

organizationIdnumberOptional

Organization Id associated with the webhook configuration

Example: 100
secretstringOptional

Secret key for the webhook

Example: s3cr3t
urlstringOptional

URL of the webhook

Example: https://example.com/webhook
headersobjectOptional

Headers for the webhook request

Example: {"Content-Type":"application/json"}
eventNamestringOptional

Event name for the webhook

Example: order.created
eventIdnumberOptional

Event Id associated with the webhook

Example: 200
versionnumberOptional

Version of the webhook configuration

Example: 1
activebooleanOptional

Indicates if the webhook is active

Example: true
isDeletedbooleanOptional

Indicates if the webhook configuration is deleted

sendOrganizationCodebooleanOptional

Indicates if the organization code should be sent

Example: true
Responses
200Success
application/json
put
/api/external-events/{configurationId}
200Success

Delete Webhook Configuration

delete

Deletes a webhook configuration

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
configurationIdnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
delete
/api/external-events/{configurationId}
200Success
Previous/Next/