Developer Settings

💡 This comprehensive guide provides step-by-step instructions for configuring SpotDraft API credentials, setting up webhooks, and accessing webhook logs, empowering users to streamline workflows and enhance automation efficiently.

📘 Introduction

SpotDraft offers robust API functionalities and webhook integration capabilities, empowering users to streamline their workflows and enhance automation. This comprehensive guide aims to provide step-by-step instructions for configuring SpotDraft API credentials, setting up webhooks, and accessing webhook logs. For further details on SpotDraft's API and webhook features, refer to the SpotDraft Public API Documentation.

🔑 Generating API Credentials

SpotDraft API credentials are essential for authenticating requests made to SpotDraft's Public APIs. Here's how to generate API credentials:

1. Login to SpotDraft: Access your SpotDraft account by logging in with your credentials.
2. Access Developer Settings: Click on the "Settings" option in the main navigation menu and select "Developer Settings".
3. Generate API Credential: Under Developer Settings, locate the option to "Generate API Credential" and click on it
   
4. Provide a Name: Enter a descriptive name for the API credentials you're generating.
5. Generate Credentials: After naming the credentials, click on the "Generate" button to create them.
   
6. Copy Client Id and Client Secret: Once generated, make sure to copy the Client Id and Client Secret provided. These credentials will be used to authenticate your API requests.
   

🔔 Setting Up Webhooks

Webhooks enable SpotDraft to send real-time notifications to your application when specific events occur. Follow these steps to set up webhooks:

1. Access Webhooks Section: Within your SpotDraft account, navigate to the "Webhooks" section, found within the Developer Settings.
   
2. Create New Webhook: In the Webhooks section, look for an option to "Create New Webhook" and click on it.
   
3. Provide a Name: Enter a descriptive name for the webhook.
   
4. Select Trigger Events: Choose the events that should trigger the webhook from the available options.
5. Enter Destination URL: Provide the URL or endpoint where SpotDraft will send webhook notifications.
6. Save and Activate: Click on the "Create" or "Save" button to activate the webhook.

📊 Viewing Webhook Logs

SpotDraft allows you to view logs related to webhook activities for monitoring and troubleshooting purposes. Here's how to access webhook logs:

1. Navigate to Webhook Logs: In your SpotDraft account, locate the option to view webhook logs, usually found within the Webhooks section or under Developer Settings.
   
2. Search by Contract Id: If needed, search for specific webhook logs by contract ID to narrow down the results.
3. View Details: Click on "View Details" for a webhook trigger to get more information about the error.
4. Check Payload: To inspect the payload of a webhook, click on "View More" and then select the "Payload" button.

🔚 Conclusion

In conclusion, configuring SpotDraft API credentials, setting up webhooks, and accessing webhook logs are crucial steps in leveraging SpotDraft's automation capabilities effectively. By following the steps outlined in this guide, users can seamlessly integrate SpotDraft with their existing systems and workflows, enhancing efficiency and productivity.