{"type":"api","title":"Create a new webhook","meta":{"id":"/apps/pubhub/media/orbital-api/eae5ef1abc124f2d904b17b1697b2df180e92067/6031b5a0-67fa-3480-bf75-857e24b55963","info":{"description":"Documentation of the Orbital API\n\nTo authenticate:\n\n\nFollow steps 1 through 3 from the SecureX Authorization section of this article to generate a SecureX Token.\nhttps://developer.cisco.com/docs/secure-endpoint/#!authentication\n\n\nclick \"Authorize\" button\nIn \"Value\" - enter token from above, prefixed with \"Bearer \" (no quotes)\nClick \"Authorize\", followed by \"Close\"\n\nNow the \"Try it out\" button can work","title":"Orbital API","version":"0.0.1"},"security":[{"AuthorizationHeader":[]}],"openapi":"3.0.3","servers":[{"description":"North America","url":"https://enterprise.orbital.amp.cisco.com/v0"},{"description":"Asia, Pacific, Japan, and China","url":"https://apjc.orbital.amp.cisco.com/v0"},{"description":"Europe","url":"https://eu.orbital.amp.cisco.com/v0"}],"securitySchemes":{"AuthorizationHeader":{"description":"Ex: Bearer \\\u003ctoken\\\u003e","in":"header","name":"authorization","type":"apiKey"}}},"spec":{"description":"Create a new webhook","operationId":"idOfHandlePostWebhook","requestBody":{"content":{"application/json":{"schema":{"properties":{"Environment":{"type":"string"},"config":{"properties":{"accessKey":{"description":"AWS access key","example":"1111111111111111","type":"string"},"bucket":{"description":"AWS S3 or Azure bucket name","example":"results-bucket","type":"string"},"fingerprint":{"description":"Webhook fingerprint","example":"sha-256 fingerprint","type":"string"},"format":{"description":"\"compact\" or \"extended\" or \"ctim\" or \"splunk-compact\" or \"splunk-expanded\" or \"s3-compact\" or \"s3-expanded\" format for results","example":"s3-expanded","type":"string"},"label":{"description":"Descriptive label","example":"my-webhook","type":"string"},"region":{"description":"AWS region","example":"us-east-1","type":"string"},"secretKey":{"description":"AWS secret key","example":"222222222222222","type":"string"},"token":{"description":"Azure token","example":"base64-encoded-jwt","type":"string"},"url":{"description":"Webhook target url azure or ctim","example":"https://example.com","type":"string"}},"type":"object","$$ref":"#/components/schemas/WebhookConfig"},"disabled":{"type":"boolean"},"id":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/WebhookRequestForHandlePost"}}},"description":"Handle post webhook request.","x-originalParamName":"Body"},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"application":{"description":"Application is the application that created the webhook.","type":"string"},"config":{"properties":{"accessKey":{"title":"String will be blank in %v, %#v, and Marshalled output.","type":"string","$$ref":"#/components/schemas/String"},"bucket":{"description":"S3 Options","type":"string"},"fingerprint":{"description":"Fingerprint is an optional user supplied cert fingerprint to assist in sever verification.","type":"string"},"format":{"description":"Optional result format type. Allowable values: ctim.","type":"string"},"label":{"description":"Label is an optional user supplied label associated with the webhook, and has no internal use.","type":"string"},"region":{"type":"string"},"secretKey":{"title":"String will be blank in %v, %#v, and Marshalled output.","type":"string","$$ref":"#/components/schemas/String"},"token":{"title":"String will be blank in %v, %#v, and Marshalled output.","type":"string","$$ref":"#/components/schemas/String"},"url":{"description":"URL is the webhook URL, required.","type":"string"}},"title":"Config contains all the user specified options related to a webhook...and allows a Jsonb column.","type":"object","$$ref":"#/components/schemas/Config"},"created":{"description":"Created is the time the webhook was created.","format":"date-time","type":"string"},"creator":{"description":"Creator is the user who created the webhook.","type":"string"},"disabled":{"description":"Disabled webhooks can not be run.","type":"boolean"},"errormessage":{"description":"ErrorMessage is the error associated with the lastStatus if it's a failure.","type":"string"},"id":{"description":"ID is the id of the webhook in the database.","type":"string"},"lastcalled":{"description":"LastCalled is the time the webhook was last called, or the zero time if never called.","format":"date-time","type":"string"},"laststatus":{"description":"LastStatus is the status from the most recent webhook attempt, success, or failure.","type":"string"},"organization":{"description":"Organization is the organization of the user who created the webhook.","type":"string"},"updated":{"description":"Updated is the time the webhook definition was most recently updated.","format":"date-time","type":"string"}},"type":"object","$$ref":"#/components/schemas/WebhookResponseForHandlePost"}}},"description":"","$$ref":"#/components/responses/HandlePostWebhookSuccessResponse"},"400":{"description":"","headers":{"errors":{"schema":{"items":{"type":"string"},"type":"array"}}},"$$ref":"#/components/responses/ErrorMsg400BadRequest"},"409":{"description":"","headers":{"errors":{"schema":{"items":{"type":"string"},"type":"array"}}},"$$ref":"#/components/responses/ErrorMsg409StatusConflict"}},"security":[{"AuthorizationHeader":[]}],"summary":"Create a new webhook","tags":["Webhooks"],"__originalOperationId":"idOfHandlePostWebhook","method":"post","path":"/webhooks"}}