# OPENFORMAT ## Docs - [Real-time Notifications](https://docs.openformat.tech/api-reference/architecture/notifications.md): Learn how to integrate your application with OPENFORMAT's webhook system to receive real-time notifications for specific events. - [Reading on-chain Data](https://docs.openformat.tech/api-reference/architecture/reading-data.md): Easily get data from our subgraph - [Transaction Lifecycle](https://docs.openformat.tech/api-reference/architecture/transaction-lifecycle.md): How OPENFORMAT creates and broadcasts transactions - [Challenge](https://docs.openformat.tech/api-reference/endpoint/api-key/post-keychallenge.md): Generate an API Key Challenge for an account. Once you've generate your challenge, you need to [verify](/api-reference/endpoint/api-key/post-keyverify) it. - [Challenge verification](https://docs.openformat.tech/api-reference/endpoint/api-key/post-keyverify.md): Verify your signed challenge. You can sign your challenge using Metamask and our [signing tool](https://openformat-tools.vercel.app/). - [Create an allowance](https://docs.openformat.tech/api-reference/endpoint/credit/post-creditapprove.md): This is endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that pre-approves a `spender_address` account to transfer a specified amount of tokens from the `holder_address` account. Once you sign this transaction, using your private key held in your local en… - [Credit Balance](https://docs.openformat.tech/api-reference/endpoint/credit/post-creditbalance.md): Show the Credit token balance of an account. - [Create Credit token](https://docs.openformat.tech/api-reference/endpoint/credit/post-creditnew.md): This is endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that creates a new Credit token from the specified app. Once you sign this transaction, using your private key held in your local environment variables, you can broadcast it using the [Execute Trans… - [Request Permit Data](https://docs.openformat.tech/api-reference/endpoint/credit/post-creditpermitdata.md): This endpoint returns the necessary data for a Credit token holder to create a permit signature. This permit is used to allow a third party to transfer tokens on behalf of the token holder. Once this permit is signed it is sent to the [Transfer Credit Token](/api-reference/endpoint/credit/post-credi… - [Transfer Credit Token](https://docs.openformat.tech/api-reference/endpoint/credit/post-credittransfer.md): This is endpoint receives transfer information, a permit signature and returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that executes the transfer. Permit data is obtained by calling the [Request Permit Data](/api-reference/endpoint/credit/post-creditpermitdata) e… - [Get Leaderboard](https://docs.openformat.tech/api-reference/endpoint/leaderboard/get-leaderboard.md): Get all Leaderboard - [Get User Profile](https://docs.openformat.tech/api-reference/endpoint/profile/get-profile.md): Get on-chain Profile - [Execute Transaction](https://docs.openformat.tech/api-reference/endpoint/transactions/post-transactionsexecute.md): Execute Transaction - [Execute Transaction and Wait](https://docs.openformat.tech/api-reference/endpoint/transactions/post-transactionsexecuteandwait.md): Execute transaction and wait for confirmation - [Reward Badge](https://docs.openformat.tech/api-reference/endpoint/triggers/post-rewardbadge.md): Trigger Reward Badge - [Transfer ERC-20](https://docs.openformat.tech/api-reference/endpoint/triggers/post-rewardcredit.md): Transfer ERC-20 tokens to users in your application. This endpoint (previously known as "Credit") enables you to reward users with ERC-20 tokens for their actions or achievements. The endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that needs to be signe… - [Mint Point/ERC-20](https://docs.openformat.tech/api-reference/endpoint/triggers/post-rewardpoint.md): Reward users with points for completing specific actions in your application. This endpoint is designed to incentivise user engagement by awarding points for various activities such as: - [Reward XP](https://docs.openformat.tech/api-reference/endpoint/triggers/post-rewardxp.md): ⚠️ **DEPRECATED**: This endpoint has been deprecated and replaced by the [Reward Point](/api-reference/endpoint/triggers/post-rewardpoint) endpoint. Please use the Reward Point endpoint for all new implementations. - [Delete Webhook](https://docs.openformat.tech/api-reference/endpoint/webhook/delete-webhook:id.md): Delete an existing webhook - [List Webhooks](https://docs.openformat.tech/api-reference/endpoint/webhook/get-webhook.md): Show all user webhooks - [Get Webhook](https://docs.openformat.tech/api-reference/endpoint/webhook/get-webhook:id.md): Show an existing webhook - [Get Webhook Logs](https://docs.openformat.tech/api-reference/endpoint/webhook/get-webhook:idlogs.md): Show all logs for a webhook - [Get Webhook Secret](https://docs.openformat.tech/api-reference/endpoint/webhook/get-webhooksecret.md): Get the webhook secret - [Create Webhook](https://docs.openformat.tech/api-reference/endpoint/webhook/post-webhook.md): Create a new webhook - [Trigger Webhook Verification](https://docs.openformat.tech/api-reference/endpoint/webhook/post-webhook:idtest.md): Trigger a webhook test - [Generate New Webhook Secret](https://docs.openformat.tech/api-reference/endpoint/webhook/post-webhooksecret.md): Create a new webhook secret - [Update Webhook](https://docs.openformat.tech/api-reference/endpoint/webhook/put-webhook:id.md): Update an existing webhook - [API Overview](https://docs.openformat.tech/api-reference/introduction.md): In this page you will learn how to work with the the OPENFORMAT API - [API Reference](https://docs.openformat.tech/api-reference/reference.md) - [Get Started](https://docs.openformat.tech/get-started.md) - [Create App](https://docs.openformat.tech/sdks/typescript/create-dApp.md) - [Quickstart](https://docs.openformat.tech/sdks/typescript/quickstart.md) - [Reward Badge](https://docs.openformat.tech/sdks/typescript/reward-badge.md) - [Reward Tokens](https://docs.openformat.tech/sdks/typescript/reward-token.md) - [Welcome](https://docs.openformat.tech/welcome.md): Integrate rewards and reputation into your community in minutes. ## OpenAPI Specs - [openapi](https://docs.openformat.tech/api-reference/openapi.json)