/

Get Webhook Configurations

get

Retrieves webhook configurations based on filters

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

namestringOptional

The name of the webhook

Example: MyWebhook

urlstringOptional

The URL of the webhook

Example: https://example.com/webhook

Responses

200Success

application/json

get

/api/external-events/

HTTPcURLJavaScriptPython

GET /api/external-events/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 12,
    "name": "DEMO",
    "organizationId": 5,
    "attributes": {},
    "secret": "asfdg23",
    "url": "abc.com",
    "headers": {},
    "eventName": "event",
    "eventId": 12,
    "webhookEvent": {},
    "isDeleted": true,
    "active": true,
    "sendOrganizationCode": true
  }
]

Add Webhook Configuration

post

Adds a new webhook configuration

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

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

post

/api/external-events/

HTTPcURLJavaScriptPython

POST /api/external-events/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "id": 1,
  "name": "Webhook for Order Events",
  "attributes": {},
  "organizationId": 100,
  "secret": "s3cr3t",
  "url": "https://example.com/webhook",
  "headers": {
    "Content-Type": "application/json"
  },
  "eventName": "order.created",
  "eventId": 200,
  "version": 1,
  "active": true,
  "isDeleted": true,
  "sendOrganizationCode": true
}

200Success

{
  "id": 12,
  "name": "DEMO",
  "organizationId": 5,
  "attributes": {},
  "secret": "asfdg23",
  "url": "abc.com",
  "headers": {},
  "eventName": "event",
  "eventId": 12,
  "webhookEvent": {},
  "isDeleted": true,
  "active": true,
  "sendOrganizationCode": true
}