Use the Giftbit connector to send and manage digital gift cards and rewards.
Integrating your application with Giftbit lets you use these operations in an automation. It exposes 18 actions, listed below. Add the connector from the Connections area, authenticate, then select its operations in the automation builder. Capabilities: actions.
Authentication
Before you begin, make sure you have the following information:
Connection Name: Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings.
Authentication Type: The authentication method for this connector is defined in the connection setup. Select the connector in the Connections area to see the fields it requires.
Authentication & setup
To authenticate with the Giftbit API, send your API token prefixed by the word Bearer (case sensitive) and a space in the "Authorization" HTTP header.
Getting Started:
Register for a free sandbox account at testbed.giftbit.com
Log into your Testbed account
Click on the Account menu and select API Keys
Generate a test token
Include the token in the header of your API calls:
Authorization: Bearer YOUR_TOKEN
You can test your authentication using the /ping endpoint, which is a convenient way to test your authentication.
Actions
Action Name | Description |
|---|---|
Add funds | Tops up your account balance with a credit card payment. Place a card on file via the Giftbit web interface first |
Cancel gift | Cancels a reward. Cannot cancel rewards that have been claimed by the recipient |
Create direct link order | Places an order for direct link rewards. URLs go straight to rewards with minimal Giftbit branding. Links are returned immediately in the response |
Create email order | Places an order for one or more emailed rewards. Giftbit delivers customized reward emails to each recipient |
Create embedded reward | Creates an in-app reward for immediate delivery. Response includes URL where recipient reveals their reward code. All rewards are automatically claimed |
Create shortlink order | Places an order for shortlink rewards with custom landing page. Your system distributes the shortlink via email, SMS, or other channels |
Get brand | Retrieves extended information about a specified brand by brand_code |
Get campaign/order | Retrieves the status and information about a specified order by client-provided id or Giftbit uuid |
Get funds | Retrieves a real-time overview of your Giftbit account balance by currency |
Get gift/reward | Retrieves detailed information and status of a specific reward by its uuid |
Get links | Retrieves shortlink or direct link URLs for an order. For shortlinks, poll every 5 minutes until links are ready |
Get object by ID | Gets an object by ID. Select object type - the endpoint path is determined by the object type |
List brands | Returns a list of reward brands available from Giftbit with detailed information including brand_code and allowed prices |
List gifts/rewards | Lists rewards with optional filters. Allows resending or cancellation of individual rewards via other endpoints |
List objects | Lists objects by type. Select object type - query parameters appear based on the selected type |
List regions | Returns a list of regions that filter results from the brands endpoint. Regions are used for Full Catalog rewards |
Ping | Tests authentication and checks the health of the Giftbit API |
Resend gift | Triggers another email delivery attempt for a reward. Not applicable to embedded rewards |
About the API
Giftbit offers a RESTful API for gift card and reward implementation. The API documentation is available at www.giftbit.com/giftbitapi and explains the function of each endpoint and how to structure requests. Giftbit provides live code examples in any language, allowing you to have your reward implementation ready in as little as one day.