Tahdah API
    • Introduction
    • Webhooks
    • Unresolved schema mappings
    • TrustGroups
      • About Trust Groups
      • Endpoints
        • List Trust Groups
        • Create a Trust Group
        • Update Trust Group
        • List Trust Group Legal Entity Members
        • List Trust Group Candidate Members
        • Add Trust Group Member
        • Remove Trust Group Member
      • Member Updated
    • EventCredits
      • Add Credits to Legal Entity
      • Event Credits Updated
    • Tracker
      • About Tracker
      • Get Candidate Targets
      • Get Legal Entity Targets
    • Pathways
      • About Pathways
      • Registrations
        • About Registrations
        • Get Registrations
        • Create Registations
        • Registration Created
      • Get Legal Entity Pathways
      • Get Pathway
    • DigitalBadges
      • Issue Digital Badge
      • Get Badge Templates
    • LegalEntities
      • People/Staff
        • Legal Entity People List
        • Connect a Person to a Legal Entity
        • Person Added
        • Roles Updated
      • Legal Entity Details
      • Create Legal Entity
      • Legal Entity Created
    • Candidates
      • EndPoints
        • Create Candidate
        • Update a Candidate
        • Delete Candidate
        • Add/Remove tags to a candidate
      • Webhooks
    • Catalogues
      • Catalogue Entry Published
    • Finance
      • Ledger Entry Created
    • Schemas
      • Inbound
      • Events
        • EventTemplateCreditRequest
        • EventTemplateCredit
      • Catalogue
        • CatalogueEntry
      • Finance
        • Currency
        • InvoiceItem
        • PaymentItem
        • LedgerEntry
        • InvoiceAddress
        • Entity
      • LearningExperiences
        • LearningExperienceRef
        • PathwayTypeRef
      • Candidate
        • CandidateRef
      • LegalEntities
        • RoleRef
        • LegalEntity
        • legalEntityIdentifier
      • TrustGroupMember
      • TrustGroup
      • temp
      • Candidate
      • HATEOAS Link

    Introduction

    Welcome to the Tahdah API.
    We are currently building this resource up and welcome any feedback from our customers.

    Getting Started#

    You can obtain an API key through the "Developer" section of your legal entity details and assign roles to it to control access.
    Then simply add an Authorization header with your API key to be able to consume any endpoint that the API key has access to via the roles assigned to it. The header value must be in the format Bearer <api-key> where <api-key> is the value you obtained from the developer console.
    To use Webhooks you will need to enable the webhooks you would like to process and enter the endpoint you would like webhooks sent to. Our webhooks make use of POST, PUT and DELETE verbs and so you will need to ensure that your endpoints are able to recieve and process these verbs correctly.
    Modified at 2025-04-16 12:52:58
    Next
    Webhooks
    Built with