Skip to content
API Reference/
/
Get a Webhook

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api/
Mock Server
https://docs.uberall.com/_mock/apis/swagger/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Create a Webhook

Request

Creates a new webhook, consisting of a pushUrl and a event type. For a list of all possible types use the GET /api/sales-partners/subscribable-event-types.

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

Webhook data to be created

pushUrlstringrequired

URL to receive webhooks

typestringrequired

Logging event type to subscribe to

Enum"ADMIN_ALERT""BRAND_DATA_POINT_REPLIED""BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL""BRAND_DATA_POINT_REPLY_APPROVE""BRAND_DATA_POINT_REPLY_REJECT""BUSINESS_CHAIN_UPDATE""BUSINESS_CHANGED_SALES_PARTNER""BUSINESS_COMMENT""BUSINESS_CREATED""BUSINESS_CSV_EXPORT"
curl -i -X POST \
  https://uberall.com/api/sales-partners/webhooks \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "pushUrl": "string",
    "type": "ADMIN_ALERT"
  }'

Responses

Successfully created webhook

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Webhook Model

response.​idinteger(int64)

The unique identifier of the Webhook

response.​dateCreatedstring(date-time)

Date of the creation

response.​lastUpdatedstring(date-time)

Date of last update

response.​pushUrlstring

URL where selected webhook event should be sent to

response.​typestring

Event type the SalesPartner wants to receive push messages for via webhook functionality. For a list of all possible types use the GET /api/sales-partners/subscribable-event-types.

Enum"ADMIN_ALERT""BRAND_DATA_POINT_REPLIED""BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL""BRAND_DATA_POINT_REPLY_APPROVE""BRAND_DATA_POINT_REPLY_REJECT""BUSINESS_CHAIN_UPDATE""BUSINESS_CHANGED_SALES_PARTNER""BUSINESS_COMMENT""BUSINESS_CREATED""BUSINESS_CSV_EXPORT"
Response
No content

Get a Webhook

Request

Returns the webhook with the given id

Security
X-API-KEY or Authorization
Path
idstringrequired

Webhook ID

curl -i -X GET \
  'https://uberall.com/api/sales-partners/webhooks/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved webhook

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Webhook Model

response.​idinteger(int64)

The unique identifier of the Webhook

response.​dateCreatedstring(date-time)

Date of the creation

response.​lastUpdatedstring(date-time)

Date of last update

response.​pushUrlstring

URL where selected webhook event should be sent to

response.​typestring

Event type the SalesPartner wants to receive push messages for via webhook functionality. For a list of all possible types use the GET /api/sales-partners/subscribable-event-types.

Enum"ADMIN_ALERT""BRAND_DATA_POINT_REPLIED""BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL""BRAND_DATA_POINT_REPLY_APPROVE""BRAND_DATA_POINT_REPLY_REJECT""BUSINESS_CHAIN_UPDATE""BUSINESS_CHANGED_SALES_PARTNER""BUSINESS_COMMENT""BUSINESS_CREATED""BUSINESS_CSV_EXPORT"
Response
No content

Delete a Webhook

Request

Deletes the webhook with the given id

Security
X-API-KEY or Authorization
Path
idstringrequired

Webhook ID

curl -i -X DELETE \
  'https://uberall.com/api/sales-partners/webhooks/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully deleted webhook

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​successboolean

Success

Example: true
Response
No content

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations

Locations

Locations

Operations