Using the Partner API and Postbacks

Who is this article for? This article will be useful to you if are a partner on PartnerStack looking to use postbacks, or the partner-facing API to access your partner data using external services.

Postbacks overview

Postbacks are notifications to an external service when events occur in the PartnerStack platform, such as commission creation. Postbacks are specific to Partners.

Creating a postback

To create a postback:

1. Click on your initial or logo in the top right-hand corner
2. Select "Your Profile" from the drop-down and navigate to the Postback tab
3. Enter your desired endpoint URL, postback name, and the event types you would like included
   1. Endpoint URL: The URL that we will call when an event occurs in the platform for your instance.
   2. Name: The name of this postback. Use this field to describe the purpose of this postback.
   3. Event Types: The types of events that this postback will be subscribed to. A postback can subscribe to multiple events.
      
4. Click Create postback

Once you have created your postback you can send a test event to your endpoint to confirm it has been set up correctly. For more information on postback please see our Postbacks technical docs.

Partner API overview

The PartnerStack Partner API allows you to return a list of Actions, Customers, Marketplace listings, Partnerships, Payouts (Withdrawals), Rewards (Commissions), or Transactions.

The Partner API uses API key to authenticate requests, and accepts it via Bearer authentication.

Once a key has been created you can return to your API tab to revel and copy the key, to rename the key label, or to regenerate or delete the key.

To create a Partner API key:

1. Click on your initial or logo in the top right-hand corner
2. Select "Your Profile" from the drop-down and navigate to the API tab
3. Click Create new key
4. Give the key a Label and click Create
   
   1. This label is internal and can be used to help you log what the key is used for
5. Copy your API key

Your API key can now be used in the Partner API as your Bearer authorization. 

To delete a Partner API key:

1. Click on your initial or logo in the top right-hand corner
2. Select "Your Profile" from the drop-down and navigate to the API tab
3. Click on the key you would like to delete
4. Click Delete key

For more information on the Partner API see our Partner API technical docs.