> ## Documentation Index > Fetch the complete documentation index at: https://developers.mypilotindex.com/llms.txt > Use this file to discover all available pages before exploring further. # A test ping > Sent when the partner calls POST /v1/partner/webhooks/test, signed and retried like every event. Its data is an empty object. ## OpenAPI ````yaml /api-reference/partner.yaml webhook ping openapi: 3.1.0 info: title: MyPilotIndex Partner API version: 1.0.0 description: >- The API of approved partner applications, such as logbooks, that act for a pilot who has granted them access on the MyPilotIndex consent screen. It is a separate document from the member API (openapi.yaml): partner routes live under /v1/partner/ and are never served to browsers. Authenticate with an access token from the identity provider's token endpoint (grant_type=client_credentials, scopes partner/) in the Authorization header. Every authenticated answer carries X-RateLimit-Limit and X-RateLimit-Remaining, the partner's daily allowance and what is left of it (a 401, and a path or method outside this document, carry neither); past the allowance the API answers 429 rate_limited with Retry-After. Errors use the shared envelope below. The API is additive within v1: new fields and routes may appear, existing ones do not change meaning. servers: - url: https://{devApiHost} description: >- Sandbox on the AWS dev environment, with synthetic pilots. The host is issued to the partner with its sandbox credential. variables: devApiHost: default: dev-api.mypilotindex.com description: The dev API host given to the partner with the sandbox credential. security: [] tags: - name: Grants description: >- A pilot connects on MyPilotIndex: the partner sends his browser to the consent page (https://mypilotindex.com/connect/{slug}?client_id&redirect_uri&scope&state&code_challenge&code_challenge_method=S256), the pilot signs in and allows, and the browser returns to the registered redirect_uri with code and state (or error=access_denied and state when he denies). The partner exchanges the code here for a grant and the pilot's pairwise id, which signs the pilot in ("Sign in with MyPilotIndex") and names him on every later call. A grant that is revoked, unknown or another partner's answers 404 on every route, identically. - name: Certificates description: >- Check a certificate a pilot shows you, such as his MPI Report, by its public id. The answer is the public verification's, and the call needs no grant. - name: Webhooks description: >- MyPilotIndex tells a partner about its grants by webhook: grant.revoked when a grant ends, and ping when the partner asks for a test. The webhook URL (https only) and its signing secret are set by MyPilotIndex when the partner is approved; the secret is shown once. Each event is a POST of the event as JSON (Content-Type application/json) signed in the Standard Webhooks scheme: webhook-id (the event id), webhook-timestamp and webhook-signature, "v1," and the base64 HMAC-SHA256 of ".." under the key the secret carries in base64 after its whsec_ prefix, over the exact bytes received. Verify the signature, refuse a timestamp more than five minutes from your clock, dedupe on webhook-id, and answer any 2xx within 10 seconds. A 5xx, a 408, a 429, a redirect (never followed), a timeout or a connection failure is retried with growing gaps for about a day (twelve attempts), with the same webhook-id and a fresh timestamp and signature. A 4xx other than 408 and 429 is taken as a refusal and not retried, except for a grant.revoked event with reason account_deleted: its grant leaves every list with the account, so it cannot be reconciled later, and it is retried within the same window on any answer but a 2xx, a 4xx included. A partner that missed other events reconciles with GET /v1/partner/grants?status=revoked&changed_since=. - name: Publishing description: >- Text a partner publishes: a post or a story as a pilot who granted feed.write or stories.write, and a post on the organization page the partner is bound to, with org.posts. Text only: no media, no YouTube link, no hangar, never anonymous. Every create takes a client_ref, 1 to 64 of letters, digits and . _ : - , unique per partner and kind: the same ref with the same body answers 200 with the stored id and replayed true, whatever the allowance says, so a retry after a lost answer is always safe; the same ref with another body, or on another grant, is 409 client_ref_reused. Bodies are compared after normalizing, so surrounding spaces do not make two creates. Text may not carry an @handle or @all, because a mention notifies people: 422 mentions_not_allowed. A personal e-mail address in the text is 400 personal_contact; a company address is fine. Rolling allowances count what was published in the last 24 hours, removed or not, on top of the daily allowance of every call: 3 posts and 5 stories per grant, 10 organization posts per partner; past them 429 publication_throttled with Retry-After. A partner removes only what it created, and on a grant only what it created on that grant: anything else is the 404 of a row that does not exist, and so is a row the pilot already removed. A removal answers 204, and a create it removed still answers its id on a retry, with replayed true. A grant whose pilot may not publish right now, because his account is suspended or its deletion is pending, answers 404 on these routes as a revoked grant does, for as long as that lasts, though it stays active in GET /v1/partner/grants. A partner's posts and stories look like the pilot's own: no answer of the member API names the partner. - name: Jobs description: >- The active listings of MyPilotIndex, and the jobs of the company a partner is bound to. jobs.read and jobs.write are the partner's own scopes: MyPilotIndex allows them per partner, on the token alone, and no pilot sees them. A job goes live at once, without the review queue, as a company's job does: the partner is a company MyPilotIndex approved under a data agreement. Publishing needs the binding to a company, which MyPilotIndex sets; without one, 403 partner_not_bound. Every create takes a client_ref, 1 to 64 of letters, digits and . _ : - , unique per partner: the same ref with the same body answers 200 with the stored id and replayed true, whatever the allowance says, so a retry after a lost answer is always safe; the same ref with another body is 409 client_ref_reused. Bodies are compared after normalizing, so member order, surrounding spaces and the spelling of a number do not make two creates. A rolling allowance counts what was published in the last 24 hours, closed or not, on top of the daily allowance of every call: 50 jobs per partner; past it 429 publication_throttled with Retry-After. A partner changes and closes only what it created, while the job's company is the one it is bound to: anything else is the 404 of a row that does not exist. Job text carries no mention rule and no contact guard: it does not reach the feed. - name: Insights description: >- The Workforce: what the pilots of MyPilotIndex look like as a market, in aggregates. insights.read is the partner's own scope, for the six screens; insights.position is a pilot's, for one pilot against his cohort. Every figure comes through the assembly the member screens use, so the floors are the server's: a cohort under the floor answers status insufficient and no section, a cell under its floor is suppressed, and a filter that would leave too few pilots is dropped, which filters.broadened says. No answer carries a count of pilots: a cohort is a band. paths: {} ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.