On-Call API › Integrations
Set or generate a signing secret
For github, gitlab, jenkins and sonarqube integrations: the secret
the tool signs its deliveries with, so EvoHub can reject anything not signed
with it.
Send {"secret": "…"} to store a secret already set in the tool (16–256
printable characters without spaces, at least 8 of them different). Send an
empty body or an empty secret to have one generated: it is returned once, in
signing_secret, with Cache-Control: no-store, and never again. Either way
the previous secret stops working at once. A secret you sent is not echoed.
Permission (API-key scope): oncall:integration:write.
Authorization
bearerAuth(oncall:integration:write)apiKeyHeader(oncall:integration:write)
Parameters
Path parameters
idstring requiredThe integration's id.
Request body
secretstringThe secret to store; empty or omitted to generate one.
Responses
200
The secret is set.
dataSigningSecretResult requiredShow SigningSecretResult properties
signing_secret_configuredbooleangeneratedbooleansigning_secretstringOnly when generated, and only in this response.
successboolean required
400
The body is not JSON (INVALID_BODY); the integration's type has no signing secret (VALIDATION_FAILED, field type); or the secret is not acceptable (VALIDATION_FAILED, field secret).
errorobject requiredcodestring requiredmessagestring requireddetailsarray of object requiredfieldstringmessagestring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
404
No such integration in your organization or your teams (INTEGRATION_NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
409
Signing secrets are not available on this server (SIGNING_SECRET_UNAVAILABLE).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
Example request
curl -X PUT 'https://evohub.io/api/v1/integrations/int_6e5d4c3b-2a19-4f8e-b7d6-c5b4a3928170/signing-secret' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{}'