Apple's server-to-server notifications

POST /v1/auth/apple/notifications

Register this URL in the App ID's Sign in with Apple settings. Apple posts consent and email changes signed with its keys.

Body

application/json

payloadstringrequired

maxLength: 16384

Responses

errors: application/problem+json

204

No Content

401

Unauthorized

422

Unprocessable Entity

500

Internal Server Error

503

Service Unavailable

Match errors on the problem's code, which stays the same, not on its message.

Send a request

Server

Body

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl -X POST "$API_URL/v1/auth/apple/notifications" \
  -H "Content-Type: application/json" \
  -d '{
  "payload": "string"
}'

body := strings.NewReader(`{
  "payload": "string"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost,
	apiURL + "/v1/auth/apple/notifications", body)
if err != nil {
	return err
}
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer res.Body.Close()

const res = await fetch(`${apiUrl}/v1/auth/apple/notifications`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "payload": "string"
  }),
});

Responseexample

{
  "code": "string",
  "status": 401,
  "title": "Unauthorized",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "string",
  "errors": [
    {
      "message": "expected length >= 1",
      "location": "body.name"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}