Create Scout Hook | Scout

1 curl -X POST https://api-prod.scoutos.com/hooks \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "hook": { 3 "created_by": { 4 "type": "string", 5 "id": "string" 6 }, 7 "updated_by": { 8 "type": "string", 9 "id": "string" 10 }, 11 "hook_config": { 12 "type": "string", 13 "target_url": "string" 14 }, 15 "name": "string", 16 "metadata": {}, 17 "parent": "string", 18 "triggering_events": [ 19 { 20 "type": "string", 21 "discriminator": { 22 "type": "blacklist", 23 "entity_ids": [ 24 "string" 25 ] 26 } 27 } 28 ], 29 "id": "string", 30 "doc_type": "scout_hook", 31 "created_at": "2024-01-15T09:30:00Z", 32 "updated_at": "2024-01-15T09:30:00Z", 33 "is_seed": true, 34 "description": "string" 35 } 36 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

hook_configobjectOptional

namestringOptional

descriptionstring or nullOptional

metadatamap from strings to any or nullOptional

triggering_eventslist of "agent.interaction.responded" or objects or nullOptional

Response

Successful Response

hookobject

Authentication

Request

Response

Errors