Skip to content

Developer

The Developer settings provide technical teams and engineers with the credentials and programmatic hooks necessary to integrate Abelo directly into your tech stack, backend services, and internal workflows.

Whether you are triggering transactional messaging via our REST API, synchronizing customer profiles from a custom CRM, or receiving real-time delivery webhooks, this section equips you with secure credentials and flexible configuration options across two primary tabs: API Keys and Webhooks.

1. API Keys

API keys authenticate your servers, e-commerce backends, CRM systems, and automated scripts when making requests to the Abelo REST API.

Creating an API Key

To generate a new API key:

  1. Navigate to Settings > Developer in the CMS.
  2. Ensure the API Keys tab is selected and click Create API Key.
  3. Enter a descriptive Name to identify the application using this key (e.g., Production Backend or Order Service).
  4. Select the Authentication type:
    • Bearer: Standard token-based authentication. Generates a Public API Key ID and API Key Secret.
    • HMAC: Cryptographic signature-based authentication. Generates a Public API Key ID, API Key Secret, and an API HMAC Secret for payload signing.
  5. Select the Scopes (permissions) granted to the key:
    • messages:send (Messages Send): Allows triggering API campaigns and sending messages.
    • webhooks:manage (Webhooks Manage): Allows creating, updating, and deleting webhook subscriptions.
    • profiles:read (Profiles Read): Allows retrieving customer profile records and consent statuses.
    • profiles:write (Profiles Write): Allows creating and updating customer profiles.
  6. Click Save (or Create).
  7. Copy your credentials (Public API Key ID, API Key Secret, and HMAC Secret if applicable) and store them securely before closing the dialog.

Token Security

API keys grant access to your organization's messaging and audience data. The full key secret is displayed only once upon generation. Abelo cannot retrieve lost keys; if a key is compromised or lost, revoke it and generate a new one.

Authenticating with API Keys

For detailed endpoints, parameter schemas, and code samples, refer to the REST API Reference.

Test with Postman

You can immediately test your newly created API keys and HMAC signatures using our Official Postman Collection & Public Workspace or clone our open-source GitHub repository.

Revoking an API Key

If an API key is no longer needed or may have been compromised:

  1. Locate the key in the API Keys list.
  2. Click the action menu and select Delete API Key.
  3. Confirm the deletion. Any subsequent requests using this key will immediately receive a 401 Unauthorized response.

2. Webhooks

Webhooks allow your external backend systems to receive real-time notifications from Abelo whenever message delivery or recipient engagement events occur.

Creating a Webhook

To register a webhook endpoint:

  1. In Settings > Developer, select the Webhooks tab.
  2. Click Create Webhook.
  3. Enter a Name for the webhook (e.g., Order Status Updates).
  4. Enter your public Endpoint URL (must use secure https://).
  5. Select the Event Topics you wish to receive:
    • message.sent: The message has been dispatched to the carrier network.
    • message.delivered: The carrier confirmed successful delivery to the recipient's handset.
    • message.seen: The recipient opened and viewed the message (supported on Viber).
    • message.clicked: The recipient clicked a tracked CTA button or link.
    • message.failed: The message could not be delivered by the network.
    • message.expired: The message exceeded its configured Time-to-Live (TTL) before delivery.
  6. Click Save Webhook.

Webhook Signature Verification

Each webhook is provisioned with a unique secret key. Abelo signs every outgoing webhook payload using HMAC SHA-256 and includes the signature in the X-Abelo-Signature header.

Your receiving server should compute the HMAC hash using your webhook secret and verify that it matches the header before processing the payload. For implementation guides and code samples, see Signature Verification.