Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Mobile First Company Webhooks API

Manage webhook endpoints to receive real-time notifications about events in your Allo account. Each endpoint subscribes to one or more event topics and is verified with a signing secret.

The Mobile First Company Webhooks API is one of 13 APIs that The Mobile First Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.withallo.com.

6 operations 3 paths 6 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.withallo.com
Authentication
API Key, API Key, API Key, API Key, API Key
Contact
Allo Support
Resource Areas
1

Authentication & Security 5

The Mobile First Company Webhooks API declares 5 security schemes for authenticating requests. An API key is passed in the header as Authorization (CallsAuth). An API key is passed in the header as Authorization (ContactsAuth). An API key is passed in the header as Authorization (ContactsWriteAuth). An API key is passed in the header as Authorization (SmsAuth). An API key is passed in the header as Authorization (ApiKeyAuth).

  • CallsAuth — Scope needed: CONVERSATIONSREAD
  • ContactsAuth — Scope needed: CONTACTSREAD
  • ContactsWriteAuth — Scope needed: CONTACTSREADWRITE
  • SmsAuth — Scope needed: SMSSEND

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 6

Manage webhook endpoints to receive real-time notifications about events in your Allo account. Each endpoint subscribes to one or more event topics and is verified with a signing…

GET
/v2/api/webhooks
List webhooks
listWebhooks → 200401429
POST
/v2/api/webhooks
Create webhook
createWebhook body → 201400401429
GET
/v2/api/webhooks/{webhook_id}
Get webhook
getWebhook 1 param → 200401404429
PUT
/v2/api/webhooks/{webhook_id}
Update webhook
updateWebhook 1 param body → 200400401404429
DELETE
/v2/api/webhooks/{webhook_id}
Delete webhook
deleteWebhook 1 param → 204401404429
GET
/v2/api/webhooks/event_types
List event types
listWebhookEventTypes → 200401429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are WebhookApiResponse (7 properties), UpdateWebhookApiRequest (4 properties), CreateWebhookApiRequest (3 properties), WebhookEventTypeApiResponse (2 properties). Each schema is shown below with its type and property counts.

WebhookTopic
string
An event topic. See the Event Catalog for payloads.
CreateWebhookApiRequest
object
3 properties 2 required
UpdateWebhookApiRequest
object
All fields optional. Only the fields you provide are changed.
4 properties
WebhookApiResponse
object
A webhook endpoint.
7 properties
ApiError
object
1 property
WebhookEventTypeApiResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-mobile-first-company-webhooks-api-openapi.yml Raw ↑

Other APIs The Mobile First Company publishes across the network.

The Mobile First Company Analytics API
The Mobile First Company Calls API
The Mobile First Company Contacts API
The Mobile First Company Conversations API
The Mobile First Company CRM API
The Mobile First Company Partner API
The Mobile First Company Phone Numbers API
The Mobile First Company Power Dialer API
The Mobile First Company SMS API
The Mobile First Company Summary Templates API
The Mobile First Company Tags API
The Mobile First Company Users API